• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 RFC 7252. For further information related to
26CoAP, 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_attribute*(3), *coap_cache*(3), *coap_context*(3), *coap_encryption*(3),
42*coap_endpoint_client*(3), *coap_handler*(3), *coap_io*(3),
43*coap_keepalive*(3), *coap_logging*(3), *coap_observe*(3), *coap_pdu_setup*(3),
44*coap_recovery*(3), *coap_resource*(3), *coap_session*(3), *coap_string*(3) and
45*coap_tls_library*(3)
46
47For example executables, see *coap-client*(5), *coap-rd*(5) and *coap-server*(5)
48
49FURTHER INFORMATION
50-------------------
51See
52
53"RFC7252: The Constrained Application Protocol (CoAP)"
54
55"RFC7641: Observing Resources in the Constrained Application Protocol (CoAP)"
56
57"RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP)"
58
59"RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response"
60
61"RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP)"
62
63"RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets"
64
65"RFC8613: Object Security for Constrained RESTful Environments (OSCORE)"
66
67"RFC8768: Constrained Application Protocol (CoAP) Hop-Limit Option"
68
69for further information.
70
71BUGS
72----
73Please report bugs on the mailing list for libcoap:
74libcoap-developers@lists.sourceforge.net or raise an issue on GitHub at
75https://github.com/obgm/libcoap/issues
76
77AUTHORS
78-------
79The libcoap project <libcoap-developers@lists.sourceforge.net>
80