#include <types.h>
Public Member Functions | |
| MsgParams () | |
| void | allowSigTlv (tlvType_e type) |
| void | removeSigTlv (tlvType_e type) |
| bool | isSigTlv (tlvType_e type) const |
| size_t | countSigTlvs () const |
Public Attributes | |
| uint8_t | transportSpecific |
| uint8_t | domainNumber |
| uint8_t | boundaryHops |
| uint8_t | minorVersion |
| bool | isUnicast |
| implementSpecific_e | implementSpecific |
| PortIdentity_t | target |
| PortIdentity_t | self_id |
| bool | useZeroGet |
| bool | rcvSignaling |
| bool | filterSignaling |
| bool | rcvSMPTEOrg |
| bool | sendAuth |
| uint8_t | rcvAuth |
Detailed Description
Fixed values to use in Management messages
Constructor & Destructor Documentation
◆ MsgParams()
| MsgParams::MsgParams | ( | ) |
empty constructor
Member Function Documentation
◆ allowSigTlv()
| void MsgParams::allowSigTlv | ( | tlvType_e | type | ) |
Add TLV type to allowed signalling filter
- Parameters
-
[in] type of TLV to allowed
◆ countSigTlvs()
| size_t MsgParams::countSigTlvs | ( | ) | const |
Query how many signalling TLVs are allowd in filter
- Returns
- number of allowed TLVs
◆ isSigTlv()
| bool MsgParams::isSigTlv | ( | tlvType_e | type | ) | const |
Query if TLV type is allowed signalling filter
- Parameters
-
[in] type of TLV to query
- Returns
- true if TLV is allowed
◆ removeSigTlv()
| void MsgParams::removeSigTlv | ( | tlvType_e | type | ) |
Remove TLV type from allowed signalling filter
- Parameters
-
[in] type of TLV to remove
Member Data Documentation
◆ boundaryHops
| uint8_t MsgParams::boundaryHops |
boundary hops
◆ domainNumber
| uint8_t MsgParams::domainNumber |
domain number
◆ filterSignaling
| bool MsgParams::filterSignaling |
use filter for signalling messages TLVs
◆ implementSpecific
| implementSpecific_e MsgParams::implementSpecific |
Implementation-specific to use
◆ isUnicast
| bool MsgParams::isUnicast |
Mark message as unicast
◆ minorVersion
| uint8_t MsgParams::minorVersion |
PTP minor version (We support 2.x)
◆ rcvAuth
| uint8_t MsgParams::rcvAuth |
Receive Authentication mode Use values from MsgParams_RcvAuth_e User must call Message::useAuth() to setup the spp pool
◆ rcvSignaling
| bool MsgParams::rcvSignaling |
parse signalling messages
◆ rcvSMPTEOrg
| bool MsgParams::rcvSMPTEOrg |
parse SMPTE Organization Extension TLV
◆ self_id
| PortIdentity_t MsgParams::self_id |
own port ID
◆ sendAuth
| bool MsgParams::sendAuth |
Send with Authentication TLV User must call Message::useAuth() to setup the key for send
◆ target
| PortIdentity_t MsgParams::target |
target port ID
◆ transportSpecific
| uint8_t MsgParams::transportSpecific |
transport specific
◆ useZeroGet
| bool MsgParams::useZeroGet |
send get with zero dataField
The documentation for this struct was generated from the following file:
- pub/types.h
