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

#include <ipcdef.hpp>

Inheritance diagram for WinNPipeOffsetUpdateMessage:
Inheritance graph
Collaboration diagram for WinNPipeOffsetUpdateMessage:
Collaboration graph

Public Member Functions

void _init ()
 Initializes interface. More...
 
void init ()
 Initializes interface and clears the Offset message. More...
 
void init (int64_t ml_phoffset, FrequencyRatio ml_freqoffset, int64_t ls_phoffset, FrequencyRatio ls_freqoffset, uint64_t local_time)
 Initializes the interface with specific values. More...
 
void init (Offset *offset)
 Initializes the interface based on the Offset structure. More...
 
int64_t getMasterLocalOffset ()
 Gets master to local phase offset. More...
 
FrequencyRatio getMasterLocalFreqOffset ()
 Gets Master to local frequency offset. More...
 
int64_t getLocalSystemOffset ()
 Gets local to system phase offset. More...
 
FrequencyRatio getLocalSystemFreqOffset ()
 Gets Local to system frequency offset. More...
 
uint64_t getLocalTime ()
 Gets local time. More...
 
- Public Member Functions inherited from WindowsNPipeMessage
void init ()
 Initializes the interface. More...
 
bool write (HANDLE pipe)
 Writes to the named pipe. More...
 
long read_ol (HANDLE pipe, long offs, HANDLE event)
 Reads from the pipe. More...
 
long read_ol_complete (HANDLE pipe)
 Reads completely the overlapped result. More...
 
long read (HANDLE pipe, long offs)
 Reads from the pipe. More...
 
NPIPE_MSG_TYPE getType ()
 Gets pipe message type. More...
 

Additional Inherited Members

- Protected Attributes inherited from WindowsNPipeMessage
DWORD sz
 
NPIPE_MSG_TYPE type
 
OVERLAPPED ol_read
 
DWORD ol_read_req
 

Detailed Description

Provides an interface to update the Offset information

Member Function Documentation

void WinNPipeOffsetUpdateMessage::_init ( )
inline

Initializes interface.

Returns
void
FrequencyRatio WinNPipeOffsetUpdateMessage::getLocalSystemFreqOffset ( )
inline

Gets Local to system frequency offset.

Returns
Local to system frequency offset
int64_t WinNPipeOffsetUpdateMessage::getLocalSystemOffset ( )
inline

Gets local to system phase offset.

Returns
local to system phase offset
uint64_t WinNPipeOffsetUpdateMessage::getLocalTime ( )
inline

Gets local time.

Returns
Local time
FrequencyRatio WinNPipeOffsetUpdateMessage::getMasterLocalFreqOffset ( )
inline

Gets Master to local frequency offset.

Returns
Master to local frequency offset
int64_t WinNPipeOffsetUpdateMessage::getMasterLocalOffset ( )
inline

Gets master to local phase offset.

Returns
master to local phase offset
void WinNPipeOffsetUpdateMessage::init ( )
inline

Initializes interface and clears the Offset message.

Returns
void
void WinNPipeOffsetUpdateMessage::init ( int64_t  ml_phoffset,
FrequencyRatio  ml_freqoffset,
int64_t  ls_phoffset,
FrequencyRatio  ls_freqoffset,
uint64_t  local_time 
)
inline

Initializes the interface with specific values.

Parameters
ml_phoffsetMaster to local phase offset in nano-seconds
ml_freqoffsetMaster to local frequency offset in the FrequencyRatio format
ls_phoffsetLocal to system phase offset in nano-seconds
ls_freqoffsetLocal to system frequency offset in the FrequencyRatio format
local_timeLocal time in nanoseconds
Returns
void
void WinNPipeOffsetUpdateMessage::init ( Offset offset)
inline

Initializes the interface based on the Offset structure.

Parameters
offset[in] Offset structure
Returns
void

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