HTTPs_InstanceInit

Initialize an HTTP server instance.

• Validate return err pointer.
• Validate pointers (configuration & file system API)
• Validate HTTP server instance configuration.
• Get HTTP server instance.
• Initialize instance OS object.
• Initialize connections pool of instance.

Files

http-s.h / http-s.c

Prototype

          HTTPs_INSTANCE  HTTPs_InstanceInit (const  HTTPs_CFG      *p_cfg,
                                              const  NET_TASK_CFG   *p_task_cfg,
                                                     HTTPs_ERR      *p_err);

Arguments

p_cfg

Pointer to the HTTP server instance configuration object.

p_task_cfg

Pointer to the instance task configuration object.

p_err

Pointer to variable that will receive the return error code.

Returned Values

Pointer to the instance handler, if NO errors;
NULL pointer, otherwise.

p_err argument should be inspected to determine whether or not HTTPs instance successfully initialized. If HTTPs instance did not successfully initialize, refer to function definition header in http-s.c for possible return error codes to locate where the HTTPs instance initialization failed.

Required Configuration

None.

Notes / Warnings

HTTPs_Init function must be called once prior to calling HTTPs_InstanceInit() for each HTTP instance to initialize.

Example Template

See section Sample Application for an example.