riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #15408 from miri64/uhcp/enh/doc

Browse Source 
uhcp: improve documentation
This commit is contained in:
Kaspar Schleiser 2020-11-09 12:39:17 +01:00 committed by GitHub
commit fb6925a018
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sys/include/net/uhcp.h
View File

@ -10,6 +10,15 @@
* @defgroup net_uhcp UHCP * @defgroup net_uhcp UHCP
* @ingroup net * @ingroup net
* @brief Provides UHCP (micro host configuration protocol) * @brief Provides UHCP (micro host configuration protocol)
*
* UHCP (micro host configuration protocol) is a RIOT-proprietary protocol that
* was developed to have a simple drop-in replacement for
* [DHCPv6 prefix delegation](@ref net_dhcpv6_client) (which was not implemented
* when UHCP was introduced).
*
* If you have root access on your host machine or access to a DHCPv6 server
* providing prefix delegation, DHCPv6 is preferred over UHCP.
*
* @{ * @{
* *
* @file * @file
@ -128,7 +137,8 @@ void uhcp_handle_push(uhcp_push_t *req, uint8_t *src, uint16_t port, uhcp_iface_
/** /**
* @brief handle incoming prefix (as parsed from push packet) * @brief handle incoming prefix (as parsed from push packet)
* *
* Supposed to be implemented by UHCP client implementations. * Supposed to be implemented by UHCP client implementations for the network
* stack.
* *
* The function might be called with an already configured prefix. In that * The function might be called with an already configured prefix. In that
* case, the lifetime *MUST* be updated. * case, the lifetime *MUST* be updated.