gPTP Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PTPMessagePathDelayReq Class Reference

#include <avbts_message.hpp>

Inheritance diagram for PTPMessagePathDelayReq:
Inheritance graph
Collaboration diagram for PTPMessagePathDelayReq:
Collaboration graph

Public Member Functions

 ~PTPMessagePathDelayReq ()
 
 PTPMessagePathDelayReq (IEEE1588Port *port)
 
void sendPort (IEEE1588Port *port, PortIdentity *destIdentity)
 Assembles PTPMessagePathDelayReq message on the IEEE1588Port payload. More...
 
void processMessage (IEEE1588Port *port)
 Processes PTP messages. More...
 
Timestamp getOriginTimestamp (void)
 Gets origin timestamp value. More...
 
- Public Member Functions inherited from PTPMessageCommon
 PTPMessageCommon (IEEE1588Port *port)
 Creates the PTPMessageCommon interface. More...
 
virtual ~PTPMessageCommon (void)
 
unsigned char * getFlags (void)
 Gets a pointer to the flags field within the PTP message. More...
 
uint16_t getSequenceId (void)
 Gets the sequenceId value within a ptp message. More...
 
void setSequenceId (uint16_t seq)
 Sets the sequence ID value to the PTP message. More...
 
MessageType getMessageType (void)
 Gets the MessageType field within the PTP message. More...
 
long long getCorrectionField (void)
 Gets the correctionField value in a Little-Endian format. More...
 
void setCorrectionField (long long correctionAmount)
 Sets the correction field. It expects the host format. More...
 
void getPortIdentity (PortIdentity *identity)
 Gets PortIdentity field. More...
 
void setPortIdentity (PortIdentity *identity)
 Sets PortIdentity value. More...
 
Timestamp getTimestamp (void)
 Gets the current Timestamp value from the PTP message. More...
 
uint32_t getTimestampCounterValue (void)
 Gets the timestamp counter value set during the RX timestamp method. More...
 
void setTimestamp (Timestamp &timestamp)
 Sets the timestamp value. More...
 
bool garbage ()
 Gets the garbage collection status. More...
 
bool isSenderEqual (PortIdentity portIdentity)
 Determine whether the message was sent by given communication technology, uuid, and port id fields. More...
 
void buildCommonHeader (uint8_t *buf)
 Builds PTP common header. More...
 

Friends

PTPMessageCommonbuildPTPMessage (char *buf, int size, LinkLayerAddress *remote, IEEE1588Port *port)
 Builds a PTP message. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PTPMessageCommon
 PTPMessageCommon (void)
 
- Protected Attributes inherited from PTPMessageCommon
unsigned char versionPTP
 
uint16_t versionNetwork
 
MessageType messageType
 
PortIdentitysourcePortIdentity
 
uint16_t sequenceId
 
LegacyMessageType control
 
unsigned char flags [2]
 
uint16_t messageLength
 
char logMeanMessageInterval
 
long long correctionField
 
unsigned char domainNumber
 
Timestamp _timestamp
 
unsigned _timestamp_counter_value
 
bool _gc
 

Detailed Description

Provides a class for building the PTP Path Delay Request message

Constructor & Destructor Documentation

PTPMessagePathDelayReq::~PTPMessagePathDelayReq ( )
inline

Destroys the PTPMessagePathDelayReq object

PTPMessagePathDelayReq::PTPMessagePathDelayReq ( IEEE1588Port port)

Builds the PTPMessagePathDelayReq message

Member Function Documentation

Timestamp PTPMessagePathDelayReq::getOriginTimestamp ( void  )
inline

Gets origin timestamp value.

Returns
Origin Timestamp
void PTPMessagePathDelayReq::processMessage ( IEEE1588Port port)
virtual

Processes PTP messages.

Parameters
port[in] IEEE1588Port
Returns
void

Reimplemented from PTPMessageCommon.

void PTPMessagePathDelayReq::sendPort ( IEEE1588Port port,
PortIdentity destIdentity 
)

Assembles PTPMessagePathDelayReq message on the IEEE1588Port payload.

Parameters
portIEEE1588Port where the message will be assembled
destIdentity[in] Destination PortIdentity
Returns
void

Friends And Related Function Documentation

PTPMessageCommon* buildPTPMessage ( char *  buf,
int  size,
LinkLayerAddress remote,
IEEE1588Port port 
)
friend

Builds a PTP message.

Parameters
buf[in] message buffer to send
sizemessage length
remoteDestination link layer address
port[in] IEEE1588 port
Returns
PTP message instance of PTPMessageCommon

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