Embedded TCP/IP stack: fnet_http_ssi_handle_t

FNET

typedef fnet_return_t(* fnet_http_ssi_handle_t) (fnet_char_t *query, fnet_uint32_t *cookie)

Callback function prototype of the SSI parameters handler.

Parameters
querySSI directive parameter string (null-terminated).
The parameter string is set to whatever appears between SSI command tag and –> in the SSI directive itself.
cookieThis parameter points to the value, initially set to zero, which can be used to associate a custom information with a connection instance. If application store context information in the cookie, it will be preserved for future calls for this request. This allows the application to associate some request-specific state.
Returns
This function must return:
  • FNET_OK if no error occurs.
  • FNET_ERR if an error occurs.
    SSI directive will be eliminated from the result HTTP page.
See also
fnet_http_ssi, fnet_http_ssi_send_t

The SSI parser invokes this callback function, when it meets SSI directive in the HTML file and the SSI command name corresponds to the name registered in the SSI table.
The query points to the SSI parameters string. If SSI directive does not have any parameters, the query points to the blank string.

Definition at line 70 of file fnet_http_ssi.h.


© 2005-2018 by Andrey Butok. http://fnet.sourceforge.net