Builder for a management TLV. More...
#include <msgCall.h>
Collaboration diagram for ptpmgmt_builder_t:
Public Attributes | |
| ptpmgmt_msg | msg |
| ptpmgmt_tlv_mem | tlv_mem |
| void(* | free )(ptpmgmt_builder builder) |
| ptpmgmt_msg(* | getMsg )(const_ptpmgmt_builder builder) |
| ptpmgmt_tlv_mem(* | getTlvMem )(const_ptpmgmt_builder builder) |
| void(* | clear )(ptpmgmt_builder builder) |
| bool(* | assign )(ptpmgmt_builder builder, enum ptpmgmt_mng_vals_e tlv_id, ptpmgmt_builder_callback callback) |
| bool(* | buildTlv )(ptpmgmt_builder builder, void *cookie, enum ptpmgmt_actionField_e actionField, enum ptpmgmt_mng_vals_e tlv_id) |
Detailed Description
Builder for a management TLV.
Call-backs used by the callHadler and callHadler_tlv.
- Note
- the actual callbacks are assing in the library Only free() should be called directly
Member Data Documentation
◆ assign
| bool(* ptpmgmt_builder_t::assign) (ptpmgmt_builder builder, enum ptpmgmt_mng_vals_e tlv_id, ptpmgmt_builder_callback callback) |
Assign tlv ID with callback function
- Parameters
-
[in] builder pointer to builder object [in] tlv_id TLV ID [in] callback to use
- Returns
- true on success
- Note
- the callback parameters must match the callback in the structure
◆ buildTlv
| bool(* ptpmgmt_builder_t::buildTlv) (ptpmgmt_builder builder, void *cookie, enum ptpmgmt_actionField_e actionField, enum ptpmgmt_mng_vals_e tlv_id) |
Allocate a management TLV, use a call-back to set its values and assign it with the Message object ready for sending
- Parameters
-
[in,out] builder object [in] cookie from user, that pass to callback [in] actionField action type [in] tlv_id TLV ID to send
- Returns
- true if setAction() succes
- Note
- This function calls Message.setAction
- For empty TLV or GET action, the function will call setAction without TLV
◆ clear
| void(* ptpmgmt_builder_t::clear) (ptpmgmt_builder builder) |
Clear the tlv in the Message object
- Parameters
-
[in,out] builder object to clean
◆ free
| void(* ptpmgmt_builder_t::free) (ptpmgmt_builder builder) |
Free this builder object
- Parameters
-
[in,out] builder object to free
◆ getMsg
| ptpmgmt_msg(* ptpmgmt_builder_t::getMsg) (const_ptpmgmt_builder builder) |
◆ getTlvMem
| ptpmgmt_tlv_mem(* ptpmgmt_builder_t::getTlvMem) (const_ptpmgmt_builder builder) |
Get pointer to the TLV memory object
- Parameters
-
[in] builder object
- Returns
- pointer the TLV memory object
◆ msg
| ptpmgmt_msg ptpmgmt_builder_t::msg |
The Message wrapper onject
◆ tlv_mem
| ptpmgmt_tlv_mem ptpmgmt_builder_t::tlv_mem |
The TLV memory object
The documentation for this struct was generated from the following file:
- pub/c/msgCall.h
