mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-16 13:04:55 +03:00
examples/coap-client.c: examples/coap-server.c: Add in Q-Block intelligence. include/coap3/block.h include/coap3/coap_block_internal.h include/coap3/coap_event.h Add in Q-Block references. Add in new functions coap_block_check_q_block1_xmit() coap_block_check_q_block2_xmit() coap_send_q_blocks() coap_send_q_block1() coap_send_q_block2() coap_block_drop_resp_q_block_xmit() coap_block_drop_resp_q_block2_crcv() coap_q_block_is_supported() include/coap3/coap_session.h: Add in new Congestion Control defaults and ability to configure them. include/coap3/pdu.h: Add in the new options. libcoap-3.map: libcoap-3.sym: Expose external Congestion Control functions. man/coap-client.txt.in: man/coap-server.txt.in: man/coap_block.txt.in: man/coap_handler.txt.in: man/coap_recovery.txt.in: man/coap.txt.in: Add in Q-Block information. src/block.c: Add in the new functions to support Q-Block. src/coap_debug.c: Output the new options as appropriate. src/coap_io.c: Check for Q-Block transmission timeouts. src/coap_session.c: Add in the Congestion Control support. src/net.c: src/resource.c: Add in Q-Block support. configure.ac CMakeLists.txt Add in support for enabling/disabling Q-Block support (enabled by default).
98 lines
4.5 KiB
Markdown
98 lines
4.5 KiB
Markdown
# libcoap: A C implementation of the Constrained Application Protocol (RFC 7252)
|
|
|
|
[](https://github.com/obgm/libcoap/actions?query=branch:main)
|
|
[](https://github.com/obgm/libcoap/actions?query=branch:develop)
|
|
[](https://scan.coverity.com/projects/obgm-libcoap)
|
|
[](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:libcoap)
|
|
[](https://github.com/obgm/libcoap/actions/workflows/cifuzz.yml)
|
|
[](https://github.com/pre-commit/pre-commit)
|
|
|
|
Copyright (C) 2010—2023 by Olaf Bergmann <bergmann@tzi.org> and others
|
|
|
|
ABOUT LIBCOAP
|
|
=============
|
|
|
|
libcoap is a C implementation of a lightweight application-protocol
|
|
for devices that are constrained their resources such as computing
|
|
power, RF range, memory, bandwidth, or network packet sizes. This
|
|
protocol, CoAP, is standardized by the IETF as RFC 7252. For further
|
|
information related to CoAP, see <https://coap.space> or
|
|
[CoAP Wiki](https://en.wikipedia.org/wiki/Constrained_Application_Protocol).
|
|
|
|
You might want to check out
|
|
[libcoap-minimal](https://github.com/obgm/libcoap-minimal) for usage
|
|
examples.
|
|
|
|
DOCUMENTATION
|
|
=============
|
|
|
|
Documentation and further information can be found at
|
|
<https://libcoap.net>.
|
|
|
|
PACKAGE CONTENTS
|
|
================
|
|
|
|
This package contains a protocol parser and basic networking
|
|
functions for platforms with support for malloc() and BSD-style
|
|
sockets. In addition, there is support for Contiki-NG, LwIP and
|
|
Espressif/ESP-IDF hosted environments.
|
|
|
|
The following RFCs are supported
|
|
|
|
* [RFC7252: The Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7252)
|
|
|
|
* [RFC7390: Group Communication for the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7390)
|
|
|
|
* [RFC7641: Observing Resources in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7641)
|
|
|
|
* [RFC7959: Block-Wise Transfers in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc7959)
|
|
|
|
* [RFC7967: Constrained Application Protocol (CoAP) Option for No Server Response](https://rfc-editor.org/rfc/rfc7967)
|
|
|
|
* [RFC8132: PATCH and FETCH Methods for the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc8132)
|
|
|
|
* [RFC8323: CoAP (Constrained Application Protocol) over TCP, TLS, and WebSockets](https://rfc-editor.org/rfc/rfc8323)
|
|
|
|
* [RFC8516: "Too Many Requests" Response Code for the Constrained Application Protocol](https://rfc-editor.org/rfc/rfc8516)
|
|
|
|
* [RFC8613: Object Security for Constrained RESTful Environments (OSCORE)](https://rfc-editor.org/rfc/rfc8613)
|
|
|
|
* [RFC8768: Constrained Application Protocol (CoAP) Hop-Limit Option](https://rfc-editor.org/rfc/rfc8768)
|
|
|
|
* [RFC8974: Extended Tokens and Stateless Clients in the Constrained Application Protocol (CoAP)](https://rfc-editor.org/rfc/rfc8974)
|
|
|
|
* [RFC9175: CoAP: Echo, Request-Tag, and Token Processing](https://rfc-editor.org/rfc/rfc9175)
|
|
|
|
* [RFC9177: Constrained Application Protocol (CoAP) Block-Wise Transfer Options Supporting Robust Transmission](https://rfc-editor.org/rfc/rfc9177)
|
|
|
|
There is (D)TLS support for the following libraries
|
|
|
|
* OpenSSL (Minimum version 1.1.0) [PKI, PSK and PKCS11]
|
|
|
|
* GnuTLS (Minimum version 3.3.0) [PKI, PSK, RPK(3.6.6+) and PKCS11]
|
|
|
|
* Mbed TLS (Minimum version 2.7.10) [PKI and PSK]
|
|
|
|
* TinyDTLS [PSK and RPK] [DTLS Only]
|
|
|
|
The examples directory contain a CoAP client, CoAP Resource Directory server
|
|
and a CoAP server to demonstrate the use of this library.
|
|
|
|
BUILDING
|
|
========
|
|
|
|
Further information can be found at <https://libcoap.net/install.html>
|
|
and [BUILDING](https://raw.githubusercontent.com/obgm/libcoap/develop/BUILDING).
|
|
|
|
LICENSE INFORMATION
|
|
===================
|
|
|
|
This library is published as open-source software without any warranty
|
|
of any kind. Use is permitted under the terms of the simplified BSD
|
|
license. It includes public domain software. libcoap binaries may also
|
|
include open-source software with their respective licensing terms.
|
|
Please refer to
|
|
[LICENSE](https://raw.githubusercontent.com/obgm/libcoap/develop/LICENSE)
|
|
for further details.
|
|
|