1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

net: NETOPT_MAX_{PACKET_SIZE -> PDU_SIZE}

Renamed NETOPT_MAX_PACKET_SIZE into NETOPT_MAX_PDU_SIZE and updated the
 documentation. NETOPT_MAX_PACKET_SIZE is introduced as preprocessor alias
 for NETOPT_MAX_PDU_SIZE to remain backward compatible and is marked as
 deprecated.
This commit is contained in:
Marian Buschsieweke 2019-02-04 12:38:25 +01:00
parent a4549f089f
commit 5ba72df5aa
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F

View File

@ -29,6 +29,14 @@
extern "C" { extern "C" {
#endif #endif
/**
* @brief A deprecated alias for @ref NETOPT_MAX_PDU_SIZE
*
* @deprecated Please use @ref NETOPT_MAX_PDU_SIZE instead of
* `NETOPT_MAX_PACKET_SIZE`
*/
#define NETOPT_MAX_PACKET_SIZE NETOPT_MAX_PDU_SIZE
/** /**
* @brief Global list of configuration options available throughout the * @brief Global list of configuration options available throughout the
* network stack, e.g. by netdev and netapi * network stack, e.g. by netdev and netapi
@ -171,9 +179,9 @@ typedef enum {
*/ */
NETOPT_TX_POWER, NETOPT_TX_POWER,
/** /**
* @brief (uint16_t) maximum packet size a network module can handle * @brief (uint16_t) maximum protocol data unit
*/ */
NETOPT_MAX_PACKET_SIZE, NETOPT_MAX_PDU_SIZE,
/** /**
* @brief (@ref netopt_enable_t) frame preloading * @brief (@ref netopt_enable_t) frame preloading
* *