PathTraceTLV Class Reference

#include <avbts_message.hpp>

Collaboration diagram for PathTraceTLV:

Public Member Functions
	PathTraceTLV ()
void	parseClockIdentity (uint8_t *buffer)
	Parses ClockIdentity from message buffer. More...
void	appendClockIdentity (ClockIdentity *id)
	Appends new ClockIdentity to internal ClockIdentity list. More...
void	toByteString (uint8_t *byte_str)
	Gets TLV value in a byte string format. More...
bool	has (ClockIdentity *id)
	Looks for a specific ClockIdentity on the current TLV. More...
int	length ()
	Gets the total length of TLV. Total length of TLV is length of type field (UINT16) + length of 'length' field (UINT16) + length of identities (each PTP_CLOCK_IDENTITY_LENGTH) in the path. More...

Detailed Description

Provides the PathTraceTLV interface The fields of the path TLV shall be as specified in Table 10-8 and in 10.5.4.3.2 through 10.5.4.3.9 from IEEE 802.1AS. This TLV, and its use, are defined in IEEE Std 1588-2008 (see 16.2 and Table 34 of IEEE Std 1588-2008).

Constructor & Destructor Documentation

PathTraceTLV::PathTraceTLV ( )

inline

Creates the PathTraceTLV interface. Sets tlvType to PATH_TRACE_TLV_TYPE using network byte order

Member Function Documentation

void PathTraceTLV::appendClockIdentity ( ClockIdentity *  id )

inline

Appends new ClockIdentity to internal ClockIdentity list.

Parameters

id	ClockIdentity to be appended

Returns

void

bool PathTraceTLV::has ( ClockIdentity *  id )

inline

Looks for a specific ClockIdentity on the current TLV.

Parameters

id	[in] Desired ClockIdentity

Returns

TRUE if it has found it, FALSE otherwise.

int PathTraceTLV::length ( )

inline

Gets the total length of TLV. Total length of TLV is length of type field (UINT16) + length of 'length' field (UINT16) + length of identities (each PTP_CLOCK_IDENTITY_LENGTH) in the path.

Returns

Total length

void PathTraceTLV::parseClockIdentity ( uint8_t *  buffer )

inline

Parses ClockIdentity from message buffer.

Parameters

buffer

[in] Message buffer. It should be at least PTP_CLOCK_IDENTITY_LENGTH bytes long.

Returns

void

void PathTraceTLV::toByteString ( uint8_t *  byte_str )

inline

Gets TLV value in a byte string format.

Parameters

byte_str

[out] Output byte string

Returns

void

---

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

• avbts_message.hpp