This hook function, if defined, is called by μC/HTTPs when receiving a POST method and that all key value pair has been HTTP-server after an HTTP request has been completely received as shown in the figure Hook Functions. It allows the upper application to do whatever wanted with data received from an HTML form.
...
in the request body. The hook function SHOULD NOT be blocking and SHOULD return quickly. A time consuming function will block the processing of the other connections and reduce the HTTP server performance. In case the request processing is time consuming, the Poll hook function SHOULD be enabled to allow the server to periodically verify if the upper application has finished the request processing. If the hook is not required by the upper application, it can be set as DEF_NULL and no function will be called.
Prototype
| Code Block |
|---|
CPU_BOOLEAN HTTPs_ReqRdySignalHook (const HTTPs_INSTANCE *p_instance,
HTTPs_CONN *p_conn,
const void *p_hook_cfg,
const HTTPs_KEY_VAL *p_data); |
Arguments
p_instancePointer to the instance structure (read only).
p_connPointer to the connection structure.
p_hook_cfg
Pointer to hook application data.
p_dataPointer to the first control key value pair, if any form was received. DEF_NULL, otherwise.
Return Values
DEF_YESIf the CGI process is completed and the response can be calledsent.
DEF_NOIf the CGI process is not completed and CGI Poll function must be called to know the end of processing.if the response cannot be sent after this call and Poll function MUST be called before sending the response
Required Configuration
See CGI FormSee section Hook Configuration.
Notes / Warnings
- The instance structure is for read-only. It must not be modified.
The following connection attributes can be accessed to analyze the connection (see HTTPssee
HTTPs_CONNin Control Structures for further details on each parameters):ClientAddrMethodFileNamePtrPathPtrReqHdrCtrReqHdrFirstPtrConnDataPtr
- In this hook function, only the under-mentioned connection parameters are allowed to be modified (see
HTTPs_CONNin Control Structures for further details on each parameters):StatusCodeFileNamePtrPathPtrFilePtrFileTypeFileLenFileLenBodyDataType
- If CGI the request data take a while to be processed:
- The processing should be done in a separate task and not in this callback function to avoid blocking other connections.
- The poll callback function should be used to allow the connection to poll periodically the upper application and verify if the CGI data request processing has been completed.
Note that The
ConnDataPtrattribute inside deHTTPHTTPs_CONNstructure can be used to store a semaphore pointer related or anything else that can help to determine the completion of the CGI request processing.
Example Template
The listing below is shown to demonstrate the µC/HTTPs HTTP-server module capabilities. That code analyses each key value pair in the list and try to find control name which is linked to led blinking functionality and change the document returned to display the led state using a data in memory as well.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
static CPU_BOOLEAN HTTPs_ReqRdySignalHook (const HTTPs_INSTANCE *p_instance,
HTTPs_CONN *p_conn,
const void *p_hook_cfg,
const HTTPs_KEY_VAL *p_data)
{
HTTPs_KEY_VAL *p_key_val;
static CPU_CHAR buf[4];
CPU_INT16S str_cmp;
CPU_SIZE_T str_len;
static CPU_BOOLEAN led1_val;
static CPU_BOOLEAN led2_val;
CPU_BOOLEAN led_val;
HTTPs_ERR err_https;
p_key_val = (HTTPs_KEY_VAL *)p_data;
while (p_key_val != DEF_NULL) { (1)
printf("Ctrl Name = %s, Value = %s\n\r",
p_key_val->KeyPtr,
p_key_val->ValPtr);
if (p_key_val->DataType == HTTPs_KEY_VAL_TYPE_PAIR) { (2)
str_cmp = Str_Cmp_N(p_key_val->KeyPtr, "LED", p_key_val->KeyLen); (3)
if (str_cmp == 0) {
str_cmp = Str_Cmp_N(p_key_val->ValPtr, "LED1", p_key_val->ValLen); (4)
if (str_cmp == 0) {
led1_val = !led1_val;
led_val = led1_val;
} else {
str_cmp = Str_Cmp_N(p_key_val->ValPtr, "LED2", p_key_val->ValLen); (5)
if (str_cmp == 0) {
led2_val = !led2_val;
led_val = led2_val;
}
}
if (led_val == DEF_ON) { (6)
str_len = Str_Len("ON");
Str_Copy(&buf[0], "ON");
} else {
str_len = Str_Len("OFF");
Str_Copy(&buf[0], "OFF");
}
HTTPs_RespBodySetParamStaticData(p_instance, (7)
p_conn,
HTTP_CONTENT_TYPE_PLAIN,
&buf[0],
str_len,
DEF_NO,
&err_https);
}
} else if (p_key_val->DataType == HTTPs_KEY_VAL_TYPE_FILE) { (8)
HTTPs_RespBodySetParamFile(p_instance, (9)
p_conn,
p_key_val->ValPtr,
HTTP_CONTENT_TYPE_UNKNOWN,
DEF_YES,
&err_https);
}
p_key_val = p_key_val->DataNextPtr;
}
return (DEF_NO);
} |
| Panel | ||
|---|---|---|
| ||
|