coap_websockets - Man Page

#include <coap3/coap.h>

int coap_ws_set_host_request(coap_session_t *session, coap_str_const_t *ws_host);

This man page describes the additional libcoap functions that are available for working with the optional WebSockets support.

CoAP Servers can be set up to listen for incoming WebSockets requests, and CoAP Clients can initiate WebSockets requests using the CoAP schemes coap_ws:// and coaps+ws://.

Function: coap_ws_set_host_request()

The coap_ws_set_host_request() function is used to set ws_host as the HTTP Host: for the session in a WebSockets request.

coap_ws_set_host_request() returns 1 if successful, else 0 if a failure.

coap_supported(3) and coap_uri(3)

See

"RFC7252: The Constrained Application Protocol (CoAP)"

"RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets"

for further information.

Please raise an issue on GitHub at https://github.com/obgm/libcoap/issues to report any bugs.

Please raise a Pull Request at https://github.com/obgm/libcoap/pulls for any fixes.

The libcoap project <libcoap-developers@lists.sourceforge.net>

coap(7), coap_supported(3).

The man page coap_ws_set_host_request(3) is an alias of coap_websockets(3).