mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 00:29:46 +01:00
cord/doc: Update references to RFC 9176
This commit is contained in:
parent
68448aec42
commit
d4fb64cfbc
@ -4,7 +4,7 @@ CoRE Resource Directory: Endpoint Example
|
||||
This example application demonstrates the usage of RIOT's Resource Directory
|
||||
(RD) endpoint module, called `cord_ep`. This module supports the registration,
|
||||
update, and removal procedures as defined in
|
||||
[draft-ietf-core-resource-directory-27](https://tools.ietf.org/html/draft-ietf-core-resource-directory-27).
|
||||
[RFC 9176](https://datatracker.ietf.org/doc/html/rfc9176).
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
@ -3,7 +3,7 @@ CoRE Resource Directory: Simple Endpoint Example
|
||||
|
||||
This example shows how a node can register with a CoRE resource directory using
|
||||
the simple registration procedure as described in
|
||||
draft-ietf-core-resource-directory-27, section 5.1.
|
||||
RFC 9176, section 5.1.
|
||||
|
||||
When running this example, you **must** define the RD server's IPv6 address
|
||||
statically, using the `RD_ADDR` environment variable:
|
||||
|
@ -4,7 +4,7 @@ CoRE Resource Directory: Lookup Example
|
||||
This example application demonstrates the usage of RIOT's Resource Directory
|
||||
(RD) lookup module, called `cord_lc`. This module supports the lookup of
|
||||
resources and endpoints as defined in
|
||||
[draft-ietf-core-resource-directory-27](https://tools.ietf.org/html/draft-ietf-core-resource-directory-27).
|
||||
[RFC 9176](https://datatracker.ietf.org/doc/html/rfc9176).
|
||||
The lookup can be done in two modes: a) raw: result of the lookup is returned
|
||||
as is. b) pre-parsed: result of the lookup is parsed and only one link is
|
||||
returned for each call.
|
||||
|
@ -14,7 +14,7 @@
|
||||
* This module implements a CoRE Resource Directory endpoint library, that
|
||||
* allows RIOT nodes to register themselves with resource directories.
|
||||
* It implements the standard endpoint functionality as defined in
|
||||
* draft-ietf-core-resource-directory-27.
|
||||
* RFC 9176.
|
||||
* @see https://datatracker.ietf.org/doc/html/rfc9176
|
||||
*
|
||||
* # Design Decisions
|
||||
|
@ -15,8 +15,8 @@
|
||||
* allows RIOT nodes to lookup resources, endpoints and groups with resource
|
||||
* directories.
|
||||
* It implements the standard lookup functionality as defined in
|
||||
* draft-ietf-core-resource-directory-27.
|
||||
* @see https://tools.ietf.org/html/draft-ietf-core-resource-directory-27
|
||||
* RFC 9176.
|
||||
* @see https://datatracker.ietf.org/doc/html/rfc9176
|
||||
*
|
||||
* ## Lookup modes
|
||||
*
|
||||
|
@ -15,11 +15,11 @@
|
||||
* # About
|
||||
* The `cord` ([Co]RE [R]esource [D]irectory) module provides endpoint and
|
||||
* lookup client functionality for interacting with CoRE Resource Directories
|
||||
* (RDs) as defined in `draft-ietf-core-resource-directory-27`.
|
||||
* (RDs) as defined in `RFC 9176`.
|
||||
*
|
||||
* @see https://tools.ietf.org/html/draft-ietf-core-resource-directory-27
|
||||
* @see https://datatracker.ietf.org/doc/html/rfc9176
|
||||
*
|
||||
* `draft-ietf-core-resource-directory-27` defines two types different roles for
|
||||
* `RFC 9176` defines two types different roles for
|
||||
* nodes when interacting with a RD:
|
||||
* - `endpoint`: registers and manages entries at the RD
|
||||
* - `client`: performs different kind of lookups
|
||||
@ -39,7 +39,7 @@
|
||||
* | EP |---- | |
|
||||
* +----+
|
||||
* ```
|
||||
* Figure copied form `draft-ietf-core-resource-directory-27`.
|
||||
* Figure copied form `RFC 9176`.
|
||||
*
|
||||
* @note In the context of this module, we refer to these roles as `endpoint
|
||||
* (ep)` and `lookup client (lc)`. This should hopefully prevent some
|
||||
@ -49,7 +49,7 @@
|
||||
* # Structure
|
||||
*
|
||||
* This module is structured in a number of submodules with goal to reflect the
|
||||
* different roles described in `draft-ietf-core-resource-directory-27`:
|
||||
* different roles described in `RFC 9176`:
|
||||
*
|
||||
* - `cord_ep`: standard endpoint implementation following the rules as
|
||||
* defined i.a. in sections 5.2, 5.3, A.1, and A.2
|
||||
|
Loading…
Reference in New Issue
Block a user