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

FreeBSD Manual Pages

  
 
  

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

NAME
     coap_lwip,  coap_lwip_dump_memory_pools, coap_lwip_set_input_wait_handler -
     Work with CoAP lwip specific API handler

SYNOPSIS
     #include <coap3/coap.h>

     void	coap_lwip_set_input_wait_handler(coap_context_t        *context,
     coap_lwip_input_wait_handler_t handler, void *input_arg);

     void coap_lwip_dump_memory_pools(coap_log_t log_level);

DESCRIPTION
     This man page describes the additional libcoap functions that are available
     for working with LwIP implementations.

     NOTE: If the following line is defined in lwipopts.h, then libcoap will re-
     serve space for one response PDU when allocating coap_pdu_t structures.

	 #define MEMP_STATS 1

CALLBACK HANDLER
     Callback Type: coap_lwip_input_wait_handler_t

	 /**
	  * LwIP callback handler that can be used to wait / timeout for the
	  * next input packet.
	  *
	  * @param arg The argument passed to the coap_lwip_set_input_wait_handler()
	  *	       function.
	  * @param milli_secs Suggested number of milli secs to wait before returning
	  *		      if no input.
	  *
	  * @return @c 1 if packet received, @c 0 for timeout, else @c -1 on error.
	  */
	 typedef int (*coap_lwip_input_wait_handler_t)(void* arg, uint32_t milli_secs);

FUNCTIONS
     Function: coap_lwip_set_input_wait_handler()

     The  coap_lwip_set_input_wait_handler()  function is used to define a call-
     back handler that is invoked by coap_io_process(3) which passes in the  in-
     put_arg  parameter  along with a suggested milli-sec wait time parameter in
     case there is no input. This callback handler is  used  to  wait  for  (and
     probably  times  out) the next input packet. This allows the application to
     define whatever mechanism it wants use for this process.

     Function: coap_lwip_dump_memory_pools()

     The coap_lwip_dump_memory_pools() function is used to dump out the  current
     state of the LwIP memory pools at logging level log_level.

     This function is always invoked by coap_free_context(3) with a log_level of
     COAP_LOG_DEBUG.

     NOTE:  For  information to be printed out, you need the following two lines
     in lwipopts.h

	 #define MEMP_STATS	    1
	 #define LWIP_STATS_DISPLAY 1

SEE ALSO
     coap_context(3) and coap_io(3)

FURTHER INFORMATION
     See

     "RFC7252: The Constrained Application Protocol (CoAP)"

     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_lwip 4.3.5 		   08/02/2026			    COAP_LWIP(3)

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

home | help