mirror of
https://github.com/espressif/openthread.git
synced 2026-10-15 20:27:40 +00:00
[message] update comment/documentation (#2903)
This commit is contained in:
committed by
Jonathan Hui
parent
68535657df
commit
3acd900bdf
@@ -443,23 +443,28 @@ public:
|
|||||||
int CopyTo(uint16_t aSourceOffset, uint16_t aDestinationOffset, uint16_t aLength, Message &aMessage) const;
|
int CopyTo(uint16_t aSourceOffset, uint16_t aDestinationOffset, uint16_t aLength, Message &aMessage) const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method creates a copy of the current Message. It allocates the new one
|
* This method creates a copy of the message.
|
||||||
* from the same Message Poll as the original Message and copies @p aLength octets of a payload.
|
|
||||||
*
|
*
|
||||||
* The `Type`, `SubType`, `LinkSecurity` and `Priority` fields on the cloned message are also
|
* It allocates the new message from the same message pool as the original one and copies @p aLength octets
|
||||||
* copied from the original one.
|
* of the payload. The `Type`, `SubType`, `LinkSecurity`, `Offset`, `InterfaceId`, and `Priority` fields on the
|
||||||
|
* cloned message are also copied from the original one.
|
||||||
*
|
*
|
||||||
* @param[in] aLength Number of payload bytes to copy.
|
* @param[in] aLength Number of payload bytes to copy.
|
||||||
*
|
*
|
||||||
* @returns A pointer to the message or NULL if insufficient message buffers are available.
|
* @returns A pointer to the message or NULL if insufficient message buffers are available.
|
||||||
|
*
|
||||||
*/
|
*/
|
||||||
Message *Clone(uint16_t aLength) const;
|
Message *Clone(uint16_t aLength) const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method creates a copy of the current Message. It allocates the new one
|
* This method creates a copy of the message.
|
||||||
* from the same Message Poll as the original Message and copies a full payload.
|
*
|
||||||
|
* It allocates the new message from the same message pool as the original one and copies the entire payload. The
|
||||||
|
* `Type`, `SubType`, `LinkSecurity`, `Offset`, `InterfaceId`, and `Priority` fields on the cloned message are also
|
||||||
|
* copied from the original one.
|
||||||
*
|
*
|
||||||
* @returns A pointer to the message or NULL if insufficient message buffers are available.
|
* @returns A pointer to the message or NULL if insufficient message buffers are available.
|
||||||
|
*
|
||||||
*/
|
*/
|
||||||
Message *Clone(void) const { return Clone(GetLength()); };
|
Message *Clone(void) const { return Clone(GetLength()); };
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user