Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

sys/net/app/cord: update doc #20921

Merged
merged 2 commits into from
Oct 24, 2024
Merged

sys/net/app/cord: update doc #20921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4fb64c
cord/doc: Update references to RFC 9176
Vjorald Oct 18, 2024
d2600f8
cord/doc: Remove the label (Not Yet Implemented) and the group part
Vjorald Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/cord_ep/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=====
Expand Down
2 changes: 1 addition & 1 deletion examples/cord_epsim/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion examples/cord_lc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion sys/include/net/cord/ep.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions sys/include/net/cord/lc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
13 changes: 6 additions & 7 deletions sys/net/application_layer/cord/doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -49,15 +49,14 @@
* # 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
* - `cord_epsim`: endpoint implementation following the simple registration
* procedure as defined in section 5.3.1
* - `cord_lc`: lookup client implementation for querying information from
* an RD using the lookup and group interfaces (**NOT
* YET IMPLEMENTED**)
* an RD using the lookup interfaces
* - `cord_config`: header file collection (default) configuration values used
* throughout this module
* - `cord_common`: shared functionality used by the above submodules
Expand Down
Loading