kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-16 10:03:50 +01:00
Code Releases Activity

gcoap: homogenize name of the module

Browse Source
This commit is contained in:
Benjamin Valentin 2023-06-08 16:33:05 +02:00
parent 661829f43f
commit d4042eedde
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
sys/include/net/gcoap.h
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @defgroup net_gcoap Gcoap * @defgroup net_gcoap GCoAP
* @ingroup net * @ingroup net
* @brief High-level interface to CoAP messaging * @brief High-level interface to CoAP messaging
* *
@ -341,15 +341,15 @@
* *
* ## DTLS as transport security ## * ## DTLS as transport security ##
* *
* Gcoap allows to use DTLS for transport security by using the @ref net_sock_dtls * GCoAP allows to use DTLS for transport security by using the @ref net_sock_dtls
* "DTLS sock API". Using the module gcoap_dtls enables the support. Gcoap * "DTLS sock API". Using the module gcoap_dtls enables the support. GCoAP
* listens for requests on CONFIG_GCOAPS_PORT, 5684 by default when DTLS is enabled. * listens for requests on CONFIG_GCOAPS_PORT, 5684 by default when DTLS is enabled.
* *
* Credentials have to been configured before use. See @ref net_credman "Credman" * Credentials have to been configured before use. See @ref net_credman "Credman"
* and @ref net_sock_dtls_creds "DTLS sock credentials API" for credential managing. * and @ref net_sock_dtls_creds "DTLS sock credentials API" for credential managing.
* Access to the DTLS socket is provided by gcoap_get_sock_dtls(). * Access to the DTLS socket is provided by gcoap_get_sock_dtls().
* *
* Gcoap includes a DTLS session management component that stores active sessions. * GCoAP includes a DTLS session management component that stores active sessions.
* By default, it tries to have CONFIG_GCOAP_DTLS_MINIMUM_AVAILABLE_SESSIONS * By default, it tries to have CONFIG_GCOAP_DTLS_MINIMUM_AVAILABLE_SESSIONS
* session slots available to keep the server responsive. If not enough sessions * session slots available to keep the server responsive. If not enough sessions
* are available the server destroys the session that has not been used for the * are available the server destroys the session that has not been used for the
@ -413,7 +413,7 @@ extern "C" {
#endif #endif
/** /**
* @defgroup net_gcoap_conf Gcoap compile configurations * @defgroup net_gcoap_conf GCoAP compile configurations
* @ingroup net_gcoap * @ingroup net_gcoap
* @ingroup config * @ingroup config
* @{ * @{

6
sys/include/net/gcoap/forward_proxy.h
View File

@ -7,9 +7,9 @@
*/ */
/** /**
* @defgroup net_gcoap_forward_proxy Gcoap Forward Proxy * @defgroup net_gcoap_forward_proxy GCoAP Forward Proxy
* @ingroup net_gcoap * @ingroup net_gcoap
* @brief Forward proxy implementation for Gcoap * @brief Forward proxy implementation for GCoAP
* @note Does not support CoAPS yet. * @note Does not support CoAPS yet.
* @see <a href="https://tools.ietf.org/html/rfc7252#section-5.7.2"> * @see <a href="https://tools.ietf.org/html/rfc7252#section-5.7.2">
* RFC 7252 * RFC 7252
@ -18,7 +18,7 @@
* @{ * @{
* *
* @file * @file
* @brief Definitions for the Gcoap forward proxy * @brief Definitions for the GCoAP forward proxy
* *
* @author Cenk Gündoğan <cenk.guendogan@haw-hamburg.de> * @author Cenk Gündoğan <cenk.guendogan@haw-hamburg.de>
*/ */

8
sys/net/application_layer/gcoap/Kconfig
View File

@ -5,10 +5,10 @@
# directory for more details. # directory for more details.
# #
menuconfig KCONFIG_USEMODULE_GCOAP menuconfig KCONFIG_USEMODULE_GCOAP
bool "Configure Gcoap" bool "Configure GCoAP"
depends on USEMODULE_GCOAP depends on USEMODULE_GCOAP
help help
Configure Gcoap module using Kconfig. If not set default values and Configure GCoAP module using Kconfig. If not set default values and
CFLAGS will be used. CFLAGS will be used.
if KCONFIG_USEMODULE_GCOAP if KCONFIG_USEMODULE_GCOAP
@ -17,7 +17,7 @@ menuconfig KCONFIG_USEMODULE_GCOAP_FORWARD_PROXY
bool "Configure forward proxy" bool "Configure forward proxy"
depends on USEMODULE_GCOAP_FORWARD_PROXY depends on USEMODULE_GCOAP_FORWARD_PROXY
help help
Configure forward proxy of Gcoap using Kconfig. Configure forward proxy of GCoAP using Kconfig.
if KCONFIG_USEMODULE_GCOAP_FORWARD_PROXY if KCONFIG_USEMODULE_GCOAP_FORWARD_PROXY
config GCOAP_FORWARD_PROXY_EMPTY_ACK_MS config GCOAP_FORWARD_PROXY_EMPTY_ACK_MS
@ -29,7 +29,7 @@ menuconfig KCONFIG_USEMODULE_GCOAP_DNS
bool "Configure DNS-over-CoAPS implementation in GCoAP" bool "Configure DNS-over-CoAPS implementation in GCoAP"
depends on USEMODULE_GCOAP_DNS depends on USEMODULE_GCOAP_DNS
help help
Configure DNS-over-CoAPS submodule of Gcoap using Kconfig. If not set Configure DNS-over-CoAPS submodule of GCoAP using Kconfig. If not set
default values and CFLAGS will be used. default values and CFLAGS will be used.
if KCONFIG_USEMODULE_GCOAP_DNS if KCONFIG_USEMODULE_GCOAP_DNS