Text of httpd.apache.org › apreq › docs › libapreq2 › apreq__parser_8h.html as Styx crawled it on Nov 20, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

libapreq2-2.17: include/apreq_parser.h File Reference

Apache Software Foundation > HTTP Server Project > Request Library Subproject Apache HTTP Server Request Library - 2.17 include Data Structures | Macros | Typedefs | Functions apreq_parser.h File Reference Apache Request Library Request body parser API. More... #include " apreq_param.h " Include dependency graph for apreq_parser.h: This graph shows which files directly or indirectly include this file: Go to the source code of this file.

Data Structures struct apreq_hook_t struct apreq_parser_t struct apreq_hook_find_param_ctx_t Macros #define APREQ_PARSER_ARGS #define APREQ_HOOK_ARGS #define APREQ_DECLARE_PARSER (f) #define APREQ_DECLARE_HOOK (f) Typedefs typedef struct apreq_hook_t apreq_hook_t typedef struct apreq_parser_t apreq_parser_t typedef apr_status_t (* apreq_parser_function_t ) ( APREQ_PARSER_ARGS ) typedef apr_status_t (* apreq_hook_function_t ) ( APREQ_HOOK_ARGS ) typedef struct apreq_hook_find_param_ctx_t apreq_hook_find_param_ctx_t Functions static APR_INLINE apr_status_t apreq_parser_run (struct apreq_parser_t *psr, apr_table_t *t, apr_bucket_brigade *bb) static APR_INLINE apr_status_t apreq_hook_run (struct apreq_hook_t *h, apreq_param_t *param, apr_bucket_brigade *bb) APREQ_DECLARE_PARSER (apreq_parse_headers) APREQ_DECLARE_PARSER (apreq_parse_urlencoded) APREQ_DECLARE_PARSER (apreq_parse_multipart) APREQ_DECLARE_PARSER (apreq_parse_generic) APREQ_DECLARE_HOOK (apreq_hook_apr_xml_parser) apreq_parser_t * apreq_parser_make ( apr_pool_t *pool, apr_bucket_alloc_t *ba, const char *content_type, apreq_parser_function_t pfn, apr_size_t brigade_limit, const char *temp_dir, apreq_hook_t *hook, void *ctx) apreq_hook_t * apreq_hook_make ( apr_pool_t *pool, apreq_hook_function_t hook, apreq_hook_t *next, void *ctx) apr_status_t apreq_parser_add_hook ( apreq_parser_t *p, apreq_hook_t *h) apreq_parser_function_t apreq_parser (const char *enctype) apr_status_t apreq_register_parser (const char *enctype, apreq_parser_function_t pfn) APREQ_DECLARE_HOOK (apreq_hook_disable_uploads) APREQ_DECLARE_HOOK (apreq_hook_discard_brigade) APREQ_DECLARE_HOOK (apreq_hook_find_param) Detailed Description Request body parser API.

Macro Definition Documentation ◆ APREQ_DECLARE_HOOK #define APREQ_DECLARE_HOOK ( f ) Value: APREQ_DECLARE_NONSTD ( apr_status_t ) \ f ( APREQ_HOOK_ARGS ) APREQ_DECLARE_NONSTD #define APREQ_DECLARE_NONSTD(d) Definition: apreq.h:60 APREQ_HOOK_ARGS #define APREQ_HOOK_ARGS Definition: apreq_parser.h:52 apr_status_t int apr_status_t Declares an API hook. ◆ APREQ_DECLARE_PARSER #define APREQ_DECLARE_PARSER ( f ) Value: APREQ_DECLARE_NONSTD ( apr_status_t ) \ f ( APREQ_PARSER_ARGS ) APREQ_PARSER_ARGS #define APREQ_PARSER_ARGS Definition: apreq_parser.h:47 Declares a API parser. ◆ APREQ_HOOK_ARGS #define APREQ_HOOK_ARGS Value: apreq_hook_t *hook, \ apreq_param_t *param, \ apr_bucket_brigade *bb apreq_hook_t Definition: apreq_parser.h:83 Hook arguments ◆ APREQ_PARSER_ARGS #define APREQ_PARSER_ARGS Value: apreq_parser_t *parser, \ apr_table_t *t, \ apr_bucket_brigade *bb apreq_parser_t Definition: apreq_parser.h:93 Parser arguments.

Typedef Documentation ◆ apreq_hook_find_param_ctx_t typedef struct apreq_hook_find_param_ctx_t apreq_hook_find_param_ctx_t Context struct for the apreq_hook_find_param hook. ◆ apreq_hook_function_t typedef apr_status_t (* apreq_hook_function_t) ( APREQ_HOOK_ARGS ) The callback function of a hook. See apreq_hook_t . ◆ apreq_hook_t typedef struct apreq_hook_t apreq_hook_t A hook is called by the parser whenever data arrives in a file upload parameter of the request body.

You may associate any number of hooks with a parser instance with apreq_parser_add_hook() . ◆ apreq_parser_function_t typedef apr_status_t (* apreq_parser_function_t) ( APREQ_PARSER_ARGS ) The callback function implementing a request body parser. ◆ apreq_parser_t typedef struct apreq_parser_t apreq_parser_t A request body parser instance. Function Documentation ◆ APREQ_DECLARE_HOOK() [1/4] APREQ_DECLARE_HOOK ( apreq_hook_apr_xml_parser ) apr_xml_parser hook.

It will parse until EOS appears. The parsed document isn't available until parsing has completed successfully. The hook's ctx pointer may be cast as ( apr_xml_doc **) to retrieve the parsed document. ◆ APREQ_DECLARE_HOOK() [2/4] APREQ_DECLARE_HOOK ( apreq_hook_disable_uploads ) Returns APREQ_ERROR_GENERAL. Effectively disables mfd parser if a file-upload field is present. ◆ APREQ_DECLARE_HOOK() [3/4] APREQ_DECLARE_HOOK ( apreq_hook_discard_brigade ) Calls apr_brigade_cleanup on the incoming brigade after passing the brigade to any subsequent hooks. ◆ APREQ_DECLARE_HOOK() [4/4] APREQ_DECLARE_HOOK ( apreq_hook_find_param ) Special purpose utility for locating a parameter during parsing.

The hook's ctx should be initialized to an apreq_hook_find_param_ctx_t *, with the name attribute set to the sought parameter name, the param attribute set to NULL, and the prev attribute set to the address of the previous hook. The param attribute will be reassigned to the first param found, and once that happens this hook is immediately removed from the chain. Remarks When used, this should always be the first hook invoked, so add it manually with ctx->prev = &parser->hook instead of using apreq_parser_add_hook. ◆ APREQ_DECLARE_PARSER() [1/4] APREQ_DECLARE_PARSER ( apreq_parse_generic ) Generic parser.

No table entries will be added to the req->body table by this parser. The parser creates a dummy apreq_param_t to pass to any configured hooks. If no hooks are configured, the dummy param's bb slot will contain a copy of the request body. It can be retrieved by casting the parser's ctx pointer to ( apreq_param_t **). ◆ APREQ_DECLARE_PARSER() [2/4] APREQ_DECLARE_PARSER ( apreq_parse_headers ) RFC 822 Header parser. It will reject all data after the first CRLF CRLF sequence (an empty line).

See apreq_parser_run() for more info on rejected data. ◆ APREQ_DECLARE_PARSER() [3/4] APREQ_DECLARE_PARSER ( apreq_parse_multipart ) RFC 2388 multipart/form-data (and XForms 1.0 multipart/related) parser. It will reject any buckets representing preamble and postamble text (this is normal behavior, not an error condition). See apreq_parser_run() for more info on rejected data. ◆ APREQ_DECLARE_PARSER() [4/4] APREQ_DECLARE_PARSER ( apreq_parse_urlencoded ) RFC 2396 application/x-www-form-urlencoded parser. ◆ apreq_hook_make() apreq_hook_t * apreq_hook_make ( apr_pool_t * pool , apreq_hook_function_t hook , apreq_hook_t * next , void * ctx ) Construct a hook.

Parameters pool used to allocate the hook. hook The hook function. next List of other hooks for this hook to call on. ctx Hook's internal scratch pad. Returns New hook. ◆ apreq_hook_run() static APR_INLINE apr_status_t apreq_hook_run ( struct apreq_hook_t * h , apreq_param_t * param , apr_bucket_brigade * bb ) static Run the hook with the current parameter and the incoming bucket brigade. The hook may modify the brigade if necessary.

Once all hooks have completed, the contents of the brigade will be added to the parameter's bb attribute. Returns APR_SUCCESS on success. All other values represent errors. ◆ apreq_parser() apreq_parser_function_t apreq_parser ( const char * enctype ) Fetch the default parser function associated with the given MIME type. Parameters enctype The desired enctype (can also be a full "Content-Type" header). Returns The parser function, or NULL if the enctype is unrecognized. ◆ apreq_parser_add_hook() apr_status_t apreq_parser_add_hook ( apreq_parser_t * p , apreq_hook_t * h ) Add a new hook to the end of the parser's hook list.

Parameters p Parser. h Hook to append. ◆ apreq_parser_make() apreq_parser_t * apreq_parser_make ( apr_pool_t * pool , apr_bucket_alloc_t * ba , const char * content_type , apreq_parser_function_t pfn , apr_size_t brigade_limit , const char * temp_dir , apreq_hook_t * hook , void * ctx ) Construct a parser. Parameters pool Pool used to allocate the parser. ba bucket allocator used to create b

The rest of this page is on the live site.