From bb1d600778c6073b10dae39bc20111dd83867245 Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Wed, 24 May 2017 09:25:11 +0200 Subject: [PATCH] net/gcoap: moved implemenation status to gcoap.h --- examples/gcoap/README.md | 12 ------------ sys/include/net/gcoap.h | 12 ++++++++++++ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/examples/gcoap/README.md b/examples/gcoap/README.md index 69660d0b8d..47209f5f86 100644 --- a/examples/gcoap/README.md +++ b/examples/gcoap/README.md @@ -11,18 +11,6 @@ Build with the standard `Makefile`. Follow the setup [instructions][2] for the g Build with `Makefile.slip`. Follow the setup instructions in README-slip.md, which are based on the [SLIP instructions][3] for the gnrc_border_router example. We also plan to provide or reference the ethos/UHCP instructions, but we don't have it working yet. -## Current Status -gcoap includes server and client capability. Available features include: - -* Message Type: Supports non-confirmable (NON) messaging. Additionally provides a callback on timeout. -* Observe extension: Provides server-side registration and notifications. -* Server and Client provide helper functions for writing the response/request. See the CoAP topic in the source documentation for details. See the gcoap example for sample implementations. -* Server allows an application to register a 'listener', which includes an array of endpoint paths and function callbacks used to write a response. -* Server listens on a port at startup; defaults to 5683. -* Client operates asynchronously; sends request and then handles response in a user provided callback. -* Client generates token; length defined at compile time. -* Options: Supports Content-Format for payload. - ## Example Use This example uses gcoap as a server on RIOT native. Then we send a request from a libcoap example client on the Linux host. diff --git a/sys/include/net/gcoap.h b/sys/include/net/gcoap.h index 9e75f4ae62..29f90b7581 100644 --- a/sys/include/net/gcoap.h +++ b/sys/include/net/gcoap.h @@ -171,6 +171,18 @@ * times out. We track the response with an entry in the * `_coap_state.open_reqs` array. * + * ## Implementation Status ## + * gcoap includes server and client capability. Available features include: + * + * - Message Type: Supports non-confirmable (NON) messaging. Additionally provides a callback on timeout. + * - Observe extension: Provides server-side registration and notifications. + * - Server and Client provide helper functions for writing the response/request. See the CoAP topic in the source documentation for details. See the gcoap example for sample implementations. + * - Server allows an application to register a 'listener', which includes an array of endpoint paths and function callbacks used to write a response. + * - Server listens on a port at startup; defaults to 5683. + * - Client operates asynchronously; sends request and then handles response in a user provided callback. + * - Client generates token; length defined at compile time. + * - Options: Supports Content-Format for payload. + * * @{ * * @file