Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Modules | Data Structures | Macros | Typedefs

Modules

 afw_request
 

Data Structures

struct  afw_request_s
 Interface afw_request public struct. More...
 
struct  afw_request_inf_s
 Interface afw_request_inf_s struct. More...
 

Macros

#define AFW_REQUEST_INTERFACE_NAME   "afw_request"
 define for interface afw_request name.
 
#define afw_request_release(instance, xctx)
 Call method release of interface afw_request. More...
 
#define afw_request_set_error_info(instance, error_info, xctx)
 Call method set_error_info of interface afw_request. More...
 
#define afw_request_read_raw_request_body(instance, buffer_size, buffer, size, more_to_read, xctx)
 Call method read_raw_request_body of interface afw_request. More...
 
#define afw_request_set_response_status_code(instance, code, reason, xctx)
 Call method set_response_status_code of interface afw_request. More...
 
#define afw_request_write_response_header(instance, name, value, xctx)
 Call method write_response_header of interface afw_request. More...
 
#define afw_request_write_raw_response_body(instance, size, buffer, xctx)
 Call method write_raw_response_body of interface afw_request. More...
 
#define afw_request_flush_response(instance, xctx)
 Call method flush_response of interface afw_request. More...
 
#define afw_request_finish_response(instance, xctx)
 Call method finish_response of interface afw_request. More...
 

Typedefs

typedef void(* afw_request_release_t) (const afw_request_t *instance, afw_xctx_t *xctx)
 
typedef void(* afw_request_set_error_info_t) (const afw_request_t *instance, const afw_object_t *error_info, afw_xctx_t *xctx)
 
typedef void(* afw_request_read_raw_request_body_t) (const afw_request_t *instance, afw_size_t buffer_size, void *buffer, afw_size_t *size, afw_boolean_t *more_to_read, afw_xctx_t *xctx)
 
typedef void(* afw_request_set_response_status_code_t) (const afw_request_t *instance, const afw_utf8_t *code, const afw_utf8_t *reason, afw_xctx_t *xctx)
 
typedef void(* afw_request_write_response_header_t) (const afw_request_t *instance, const afw_utf8_t *name, const afw_utf8_t *value, afw_xctx_t *xctx)
 
typedef void(* afw_request_write_raw_response_body_t) (const afw_request_t *instance, afw_size_t size, const void *buffer, afw_xctx_t *xctx)
 
typedef void(* afw_request_flush_response_t) (const afw_request_t *instance, afw_xctx_t *xctx)
 
typedef void(* afw_request_finish_response_t) (const afw_request_t *instance, afw_xctx_t *xctx)
 

Detailed Description

Adaptive framework request interface.

Macro Definition Documentation

◆ afw_request_finish_response

#define afw_request_finish_response (   instance,
  xctx 
)
Value:
(instance)->inf->finish_response( \
(instance), \
(xctx) \
)

Call method finish_response of interface afw_request.

Parameters
instancePointer to this adaptive request instance.
xctxThis is the caller's xctx.

Definition at line 4291 of file afw_interface.h.

◆ afw_request_flush_response

#define afw_request_flush_response (   instance,
  xctx 
)
Value:
(instance)->inf->flush_response( \
(instance), \
(xctx) \
)

Call method flush_response of interface afw_request.

Parameters
instancePointer to this adaptive request instance.
xctxThis is the caller's xctx.

Definition at line 4277 of file afw_interface.h.

◆ afw_request_read_raw_request_body

#define afw_request_read_raw_request_body (   instance,
  buffer_size,
  buffer,
  size,
  more_to_read,
  xctx 
)
Value:
(instance)->inf->read_raw_request_body( \
(instance), \
(buffer_size), \
(buffer), \
(size), \
(more_to_read), \
(xctx) \
)

Call method read_raw_request_body of interface afw_request.

Parameters
instancePointer to this adaptive request instance.
buffer_sizeLength of the buffer in bytes.
bufferBuffer to store data read.
sizePlace to return number of bytes read.
more_to_readIndicate there is more input to read.
xctxThis is the caller's xctx.

Definition at line 4194 of file afw_interface.h.

◆ afw_request_release

#define afw_request_release (   instance,
  xctx 
)
Value:
(instance)->inf->release( \
(instance), \
(xctx) \
)

Call method release of interface afw_request.

Parameters
instancePointer to this adaptive request instance.
xctxThis is the caller's xctx.

Definition at line 4159 of file afw_interface.h.

◆ afw_request_set_error_info

#define afw_request_set_error_info (   instance,
  error_info,
  xctx 
)
Value:
(instance)->inf->set_error_info( \
(instance), \
(error_info), \
(xctx) \
)

Call method set_error_info of interface afw_request.

Parameters
instancePointer to this adaptive request instance.
error_infoError info object pointer.
xctxThis is the caller's xctx.

Definition at line 4174 of file afw_interface.h.

◆ afw_request_set_response_status_code

#define afw_request_set_response_status_code (   instance,
  code,
  reason,
  xctx 
)
Value:
(instance)->inf->set_response_status_code( \
(instance), \
(code), \
(reason), \
(xctx) \
)

Call method set_response_status_code of interface afw_request.

Parameters
instancePointer to this adaptive request instance.
codeThree-digit status code that conforms to http RFC.
reasonStatus reason phrase. If NULL and the status_code is standard, the standard phrase is supplied.
xctxThis is the caller's xctx.

Definition at line 4219 of file afw_interface.h.

◆ afw_request_write_raw_response_body

#define afw_request_write_raw_response_body (   instance,
  size,
  buffer,
  xctx 
)
Value:
(instance)->inf->write_raw_response_body( \
(instance), \
(size), \
(buffer), \
(xctx) \
)

Call method write_raw_response_body of interface afw_request.

Parameters
instancePointer to this adaptive request instance.
sizeNumber of bytes in buffer to write.
bufferBuffer to write.
xctxThis is the caller's xctx.

Definition at line 4259 of file afw_interface.h.

◆ afw_request_write_response_header

#define afw_request_write_response_header (   instance,
  name,
  value,
  xctx 
)
Value:
(instance)->inf->write_response_header( \
(instance), \
(name), \
(value), \
(xctx) \
)

Call method write_response_header of interface afw_request.

Parameters
instancePointer to this adaptive request instance.
nameType of header.
valueValue of header.
xctxThis is the caller's xctx.

Definition at line 4239 of file afw_interface.h.

Typedef Documentation

◆ afw_request_finish_response_t

typedef void(* afw_request_finish_response_t) (const afw_request_t *instance, afw_xctx_t *xctx)
See also
afw_request_finish_response()

Definition at line 4136 of file afw_interface.h.

◆ afw_request_flush_response_t

typedef void(* afw_request_flush_response_t) (const afw_request_t *instance, afw_xctx_t *xctx)
See also
afw_request_flush_response()

Definition at line 4130 of file afw_interface.h.

◆ afw_request_read_raw_request_body_t

typedef void(* afw_request_read_raw_request_body_t) (const afw_request_t *instance, afw_size_t buffer_size, void *buffer, afw_size_t *size, afw_boolean_t *more_to_read, afw_xctx_t *xctx)
See also
afw_request_read_raw_request_body()

Definition at line 4096 of file afw_interface.h.

◆ afw_request_release_t

typedef void(* afw_request_release_t) (const afw_request_t *instance, afw_xctx_t *xctx)
See also
afw_request_release()

Definition at line 4083 of file afw_interface.h.

◆ afw_request_set_error_info_t

typedef void(* afw_request_set_error_info_t) (const afw_request_t *instance, const afw_object_t *error_info, afw_xctx_t *xctx)
See also
afw_request_set_error_info()

Definition at line 4089 of file afw_interface.h.

◆ afw_request_set_response_status_code_t

typedef void(* afw_request_set_response_status_code_t) (const afw_request_t *instance, const afw_utf8_t *code, const afw_utf8_t *reason, afw_xctx_t *xctx)
See also
afw_request_set_response_status_code()

Definition at line 4106 of file afw_interface.h.

◆ afw_request_write_raw_response_body_t

typedef void(* afw_request_write_raw_response_body_t) (const afw_request_t *instance, afw_size_t size, const void *buffer, afw_xctx_t *xctx)
See also
afw_request_write_raw_response_body()

Definition at line 4122 of file afw_interface.h.

◆ afw_request_write_response_header_t

typedef void(* afw_request_write_response_header_t) (const afw_request_t *instance, const afw_utf8_t *name, const afw_utf8_t *value, afw_xctx_t *xctx)
See also
afw_request_write_response_header()

Definition at line 4114 of file afw_interface.h.