1// -*- mode:doc; -*- 2// vim: set syntax=asciidoc tw=0 3 4coap(7) 5======= 6:doctype: manpage 7:man source: coap 8:man version: @PACKAGE_VERSION@ 9:man manual: libcoap Manual 10 11NAME 12---- 13coap - Overview of the libcoap library 14 15SYNOPSIS 16-------- 17Summary of the different libcoap API manual pages. 18 19DESCRIPTION 20----------- 21 22libcoap is a C implementation of a lightweight application-protocol for 23devices that are constrained by their resources such as computing power, RF 24range, memory, bandwidth, or network packet sizes. This protocol, CoAP, is 25standardized by the IETF as https://rfc-editor.org/rfc/rfc7252[RFC7252]. 26For further information related to CoAP, see http://coap.technology. 27 28Documentation for the specific library calls with examples can be found in the 29man pages referred to in SEE ALSO. 30 31Further information can be found in the include header files with example 32code provided in the examples directory. 33 34*NOTE:* This documentation is a work in progress. Any missing information can 35be found in the include header files along with example code provided in the 36examples directory. 37 38 39SEE ALSO 40-------- 41*coap_address*(3), *coap_async*(3), *coap_attribute*(3), *coap_block*(3), 42*coap_cache*(3), *coap_context*(3), *coap_deprecated*(3), *coap_encryption*(3), 43*coap_endpoint_client*(3), *coap_endpoint_server*(3), *coap_handler*(3), 44*coap_io*(3), *coap_keepalive*(3), *coap_logging*(3), *coap_lwip*(3), 45*coap_observe*(3), *coap_oscore*(3), *coap_pdu_access*(3), *coap_pdu_setup*(3), 46*coap_persist*(3), *coap_recovery*(3), *coap_resource*(3), *coap_session*(3), 47*coap_string*(3), *coap_tls_library*(3), *coap_uri*(3) and *coap_websockets*(3) 48 49For example executables, see *coap-client*(5), *coap-rd*(5) and *coap-server*(5) 50 51For OSCORE configuration, see *coap-oscore-conf*(5) 52 53FURTHER INFORMATION 54------------------- 55See 56 57"https://rfc-editor.org/rfc/rfc7252[RFC7252: The Constrained Application Protocol (CoAP)]" 58 59"https://rfc-editor.org/rfc/rfc7390[RFC7390: Group Communication for the Constrained Application Protocol (CoAP)]" 60 61"https://rfc-editor.org/rfc/rfc7641[RFC7641: Observing Resources in the Constrained Application Protocol (CoAP)]" 62 63"https://rfc-editor.org/rfc/rfc7959[RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP)]" 64 65"https://rfc-editor.org/rfc/rfc7967[RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response]" 66 67"https://rfc-editor.org/rfc/rfc8132[RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP)]" 68 69"https://rfc-editor.org/rfc/rfc8323[RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets]" 70 71"https://rfc-editor.org/rfc/rfc8516[RFC8516: "Too Many Requests" Response Code for the Constrained Application Protocol]" 72 73"https://rfc-editor.org/rfc/rfc8613[RFC8613: Object Security for Constrained RESTful Environments (OSCORE)]" 74 75"https://rfc-editor.org/rfc/rfc8768[RFC8768: Constrained Application Protocol (CoAP) Hop-Limit Option]" 76 77"https://rfc-editor.org/rfc/rfc8974[RFC8974: Extended Tokens and Stateless Clients in the Constrained Application Protocol (CoAP)]" 78 79"https://rfc-editor.org/rfc/rfc9175[RFC9175: CoAP: Echo, Request-Tag, and Token Processing]" 80 81"https://rfc-editor.org/rfc/rfc9177[RFC9177: Constrained Application Protocol (CoAP) Block-Wise Transfer Options Supporting Robust Transmission]" 82 83for further information. 84 85BUGS 86---- 87Please report bugs on the mailing list for libcoap: 88libcoap-developers@lists.sourceforge.net or raise an issue on GitHub at 89https://github.com/obgm/libcoap/issues 90 91AUTHORS 92------- 93The libcoap project <libcoap-developers@lists.sourceforge.net> 94