libptpmgmt  1.3
libptpmgmt library that provides the functionality of linuxptp pmc
Public Attributes | List of all members
ptpmgmt_MsgParams Struct Reference

#include <types.h>

Collaboration diagram for ptpmgmt_MsgParams:
Collaboration graph
[legend]

Public Attributes

uint8_t transportSpecific
 
uint8_t domainNumber
 
uint8_t boundaryHops
 
uint8_t minorVersion
 
bool isUnicast
 
enum ptpmgmt_implementSpecific_e implementSpecific
 
struct ptpmgmt_PortIdentity_t target
 
struct ptpmgmt_PortIdentity_t self_id
 
bool useZeroGet
 
bool rcvSignaling
 
bool filterSignaling
 
bool rcvSMPTEOrg
 
bool sendAuth
 
uint8_t rcvAuth
 
void(* allowSigTlv )(ptpmgmt_pMsgParams mp, enum ptpmgmt_tlvType_e type)
 
void(* removeSigTlv )(ptpmgmt_pMsgParams mp, enum ptpmgmt_tlvType_e type)
 
bool(* isSigTlv )(ptpmgmt_cpMsgParams m, enum ptpmgmt_tlvType_e type)
 
size_t(* countSigTlvs )(ptpmgmt_cpMsgParams m)
 
void(* free )(ptpmgmt_pMsgParams mp)
 

Detailed Description

Fixed values to use in Management messages

Member Data Documentation

◆ allowSigTlv

void(* ptpmgmt_MsgParams::allowSigTlv) (ptpmgmt_pMsgParams mp, enum ptpmgmt_tlvType_e type)

Add TLV type to allowed signalling filter

Parameters
[in,out]mppointer to MsgParams wrapper structure
[in]typeof TLV to allowed

◆ boundaryHops

uint8_t ptpmgmt_MsgParams::boundaryHops

boundary hops

◆ countSigTlvs

size_t(* ptpmgmt_MsgParams::countSigTlvs) (ptpmgmt_cpMsgParams m)

Query how many signalling TLVs are allowd in filter

Parameters
[in]mppointer to MsgParams wrapper structure
Returns
number of allowed TLVs

◆ domainNumber

uint8_t ptpmgmt_MsgParams::domainNumber

domain number

◆ filterSignaling

bool ptpmgmt_MsgParams::filterSignaling

use filter for signalling messages TLVs

◆ free

void(* ptpmgmt_MsgParams::free) (ptpmgmt_pMsgParams mp)

Free structure object

Parameters
[in,out]mppointer to MsgParams wrapper structure

◆ implementSpecific

enum ptpmgmt_implementSpecific_e ptpmgmt_MsgParams::implementSpecific

Implementation-specific to use

◆ isSigTlv

bool(* ptpmgmt_MsgParams::isSigTlv) (ptpmgmt_cpMsgParams m, enum ptpmgmt_tlvType_e type)

Query if TLV type is allowed signalling filter

Parameters
[in]mppointer to MsgParams wrapper structure
[in]typeof TLV to query
Returns
true if TLV is allowed

◆ isUnicast

bool ptpmgmt_MsgParams::isUnicast

Mark message as unicast

◆ minorVersion

uint8_t ptpmgmt_MsgParams::minorVersion

PTP minor version (We support 2.x)

◆ rcvAuth

uint8_t ptpmgmt_MsgParams::rcvAuth

Receive Authentication mode Use values from MsgParams_RcvAuth_e User must call Message::useAuth() to setup the spp pool

◆ rcvSignaling

bool ptpmgmt_MsgParams::rcvSignaling

parse signalling messages

◆ rcvSMPTEOrg

bool ptpmgmt_MsgParams::rcvSMPTEOrg

parse SMPTE Organization Extension TLV

◆ removeSigTlv

void(* ptpmgmt_MsgParams::removeSigTlv) (ptpmgmt_pMsgParams mp, enum ptpmgmt_tlvType_e type)

Remove TLV type from allowed signalling filter

Parameters
[in,out]mppointer to MsgParams wrapper structure
[in]typeof TLV to remove

◆ self_id

struct ptpmgmt_PortIdentity_t ptpmgmt_MsgParams::self_id

own port ID

◆ sendAuth

bool ptpmgmt_MsgParams::sendAuth

Send with Authentication TLV User must call Message::useAuth() to setup the key for send

◆ target

struct ptpmgmt_PortIdentity_t ptpmgmt_MsgParams::target

target port ID

◆ transportSpecific

uint8_t ptpmgmt_MsgParams::transportSpecific

< transport specific

◆ useZeroGet

bool ptpmgmt_MsgParams::useZeroGet

send get with zero dataField


The documentation for this struct was generated from the following file: