Symbols ![]()
loading...
Files ![]()
loading...
protocomm_set_security() function
Add endpoint security for a protocomm instance This API will bind a security session establisher to the specified endpoint name, along with any proof of possession that may be required for authenticating a session client.
Syntax
esp_err_t protocomm_set_security(protocomm_t *pc,
const char *ep_name,
const protocomm_security_t *sec,
const void *sec_params);
Implemented in ![]()
protocomm.c:278
Return value
- ESP_OK : Success - ESP_FAIL : Error adding endpoint / Endpoint with this name already exists - ESP_ERR_INVALID_STATE : Security endpoint already set - ESP_ERR_NO_MEM : Error allocating endpoint resource - ESP_ERR_INVALID_ARG : Null instance/name/handler arguments
Notes
- An endpoint must be bound to a valid protocomm instance, created using `protocomm_new()`. - The choice of security can be any `protocomm_security_t` instance. Choices `protocomm_security0` and `protocomm_security1` and `protocomm_security2` are readily available.
Related Functions
Found 25 other functions taking a ![]()
protocomm
argument:
Function
Description
Delete a protocomm instance This API will deallocate a protocomm instance that was created using `protocomm_new()`.
Remove endpoint request handler for a protocomm instance This API will remove a registered endpoint handler identified by an endpoint name.
Add endpoint request handler for a protocomm instance This API will bind an endpoint handler function to the specified endpoint name, along with any private data that needs to be pass to the handler at the time of call.
Calls the registered handler of an endpoint session for processing incoming data and generating the response
Start Bluetooth Low Energy based transport layer for provisioning Initialize and start required BLE service for provisioning. This includes the initialization for characteristics/service for BLE.
Stop Bluetooth Low Energy based transport layer for provisioning Stops service/task responsible for BLE based interactions for provisioning
Stop HTTPD protocomm transport This API cleans up the HTTPD transport protocomm and frees all the handlers registered with the protocomm.
Set endpoint for version verification This API can be used for setting an application specific protocol version which can be verified by clients through the endpoint.
Start HTTPD protocomm transport This API internally creates a framework to allow endpoint registration and security configuration for the protocomm.
Remove endpoint security for a protocomm instance This API will remove a registered security endpoint identified by an endpoint name.
Remove version verification endpoint from a protocomm instance This API will remove a registered version endpoint identified by an endpoint name.
Stop console protocomm transport
Start console based protocomm transport
Allocates internal resources for new transport session
Frees internal resources used by a transport session