This hook function is called by μC/HTTPs before starting to transmit the response message as shown on Figure 4-1. It allows the upper application to add header field to the response by calling a specific API function with header field type and value.
Prototype
Arguments
p_instance
Pointer to the instance structure (read only).
p_conn
Pointer to the connection structure (read only).
Return ValueS
DEF_YES
If all header fields are added without error.
DEF_NO
otherwise.
Required Configuration
See section 4-4-6 “Instance Header Field Configuration” on page 29.
Notes / Warnings
- The instance structure is for read-only. It must not be modified.
- Connection structure must not be modified by this function since the response is mostly ready to be transmitted.
Example Template
Listing 4-18 is shown to demonstrate the µC/HTTPs module capabilities. That code simply add two header fields to a response message for an HTML document.
L4-21(1) Ensure that we don’t add header field to a response with an error
L4-21(2) Make sure to add header field only on HTML document.
L4-21(3) Acquire and add a first header field block of type ‘Cookie’ and with a string value type to the connection
L4-21(4) Set the value string value (cookie content) and the string length.
L4-21(5) Acquire and add a second header field block of type ‘Server’ and with a string value type to the connection
L4-21(6) Set the value string value (server name) and the string length.