TCPIP_HTTP_NET_USER_CALLBACK Structure

C

typedef struct _tag_TCPIP_HTTP_NET_USER_CALLBACK {
    TCPIP_HTTP_NET_IO_RESULT (* getExecute)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);
    TCPIP_HTTP_NET_IO_RESULT (* postExecute)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);
    uint8_t (* fileAuthenticate)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const char* cFile, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);
    uint8_t (* userAuthenticate)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const char* cUser, const char* cPass, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);
    TCPIP_HTTP_DYN_PRINT_RES (* dynamicPrint)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const TCPIP_HTTP_DYN_VAR_DCPT* varDcpt, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);
    void (* dynamicAck)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const void* buffer, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);
    void (* eventReport)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, TCPIP_HTTP_NET_EVENT_TYPE evType, const void* evInfo, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);
    bool (* ssiNotify)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, TCPIP_HTTP_SSI_NOTIFY_DCPT* pSSINotifyDcpt, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);
} TCPIP_HTTP_NET_USER_CALLBACK;

Description

Structure: TCPIP_HTTP_NET_USER_CALLBACK

This data structure defines the user callbacks that are implemented by the user and the HTTP server calls at run-time.

Members

MembersDescription
TCPIP_HTTP_NET_IO_RESULT (* getExecute)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);template_ConnectionGetExecute GET process function.
TCPIP_HTTP_NET_IO_RESULT (* postExecute)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);template_ConnectionPostExecute POST process function.
uint8_t (* fileAuthenticate)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const char* cFile, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);template_ConnectionFileAuthenticate File Authenticate function.
uint8_t (* userAuthenticate)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const char* cUser, const char* cPass, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);template_ConnectionUserAuthenticate User Authenticate function.
TCPIP_HTTP_DYN_PRINT_RES (* dynamicPrint)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const TCPIP_HTTP_DYN_VAR_DCPT* varDcpt, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);template_DynPrint Dynamic variable process function.
void (* dynamicAck)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, const void* buffer, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);template_DynAcknowledge Dynamic variable acknowledge function.
void (* eventReport)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, TCPIP_HTTP_NET_EVENT_TYPE evType, const void* evInfo, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);template_EventReport run-time HTTP processing report.
bool (* ssiNotify)(TCPIP_HTTP_NET_CONN_HANDLE connHandle, TCPIP_HTTP_SSI_NOTIFY_DCPT* pSSINotifyDcpt, const struct _tag_TCPIP_HTTP_NET_USER_CALLBACK* pCBack);template_SSINotification run-time HTTP SSI processing.

Remarks

See the detailed explanation for each callback in the callback templates section.

The extra pCBack parameter is passed back for allowing the user to store additional info in the supplied TCPIP_HTTP_NET_USER_CALLBACK data structure that could be used at run-time.