Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
COAP_WEBSOCKETS(3)		libcoap	Manual		    COAP_WEBSOCKETS(3)

NAME
       coap_websockets,	coap_ws_set_host_request - Work	with CoAP WebSockets

SYNOPSIS
       #include	<coap3/coap.h>

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

DESCRIPTION
       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://.

FUNCTIONS
       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.

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

SEE ALSO
       coap_supported(3) and coap_uri(3)

FURTHER	INFORMATION
       See

       "RFC7252: The Constrained Application Protocol (CoAP)"

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

       for further information.

BUGS
       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.

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

coap_websockets	4.3.5		  11/03/2025		    COAP_WEBSOCKETS(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=coap_websockets&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help