ESP SDK C API
Functions
Server Options
Server

Functions

ESPAPICALL EspServerOptionsesp_server_options_create (EspError *error)
ESPAPICALL int32_t esp_server_options_set_access_mode (EspServerOptions *server_options, ESP_ACCESS_MODE_T mode, EspError *error)
ESPAPICALL int32_t esp_server_options_set_dispatcher (EspServerOptions *server_options, EspDispatcher *dispatcher, EspError *error)
ESPAPICALL int32_t esp_server_options_set_updater (EspServerOptions *server_options, EspUpdater *updater, EspError *error)
ESPAPICALL int32_t esp_server_options_set_retrycount (EspServerOptions *server_options, const uint32_t count, EspError *error)
ESPAPICALL int32_t esp_server_options_free (EspServerOptions *server_options, EspError *error)

Function Documentation

ESPAPICALL EspServerOptions* esp_server_options_create ( EspError *  error)

Creates a server options object with default values.

ESPAPICALL int32_t esp_server_options_free ( EspServerOptions server_options,
EspError *  error 
)

Free a server options object previously obtained using esp_server_options_create.

ESPAPICALL int32_t esp_server_options_set_access_mode ( EspServerOptions server_options,
ESP_ACCESS_MODE_T  mode,
EspError *  error 
)

Sets the mode the entity will be accessed with - DIRECT, CALLBACK or SELECT.

Returns:
0 on success.
ESPAPICALL int32_t esp_server_options_set_dispatcher ( EspServerOptions server_options,
EspDispatcher dispatcher,
EspError *  error 
)

Not in R5.

ESPAPICALL int32_t esp_server_options_set_retrycount ( EspServerOptions server_options,
const uint32_t  count,
EspError *  error 
)

In CALLBACK/SELECT access modes, if set to a positive value, EspServer will not disconnect even if all manager instances go down. It will generate an ESP_SERVER_EVENT_STALE. If it is able to reconnect it will generate an ESP_SERVER_EVENT_UPTODATE.

Returns:
0 on success.
ESPAPICALL int32_t esp_server_options_set_updater ( EspServerOptions server_options,
EspUpdater updater,
EspError *  error 
)

Not in R5.

 All Classes Variables