gPTP Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OS_IPC Class Referenceabstract

#include <avbts_osipc.hpp>

Inheritance diagram for OS_IPC:
Inheritance graph
Collaboration diagram for OS_IPC:
Collaboration graph

Public Member Functions

virtual bool init (OS_IPC_ARG *arg=NULL)=0
 Initializes the IPC. More...
 
virtual bool update (int64_t ml_phoffset, int64_t ls_phoffset, FrequencyRatio ml_freqoffset, FrequencyRatio ls_freq_offset, uint64_t local_time, uint32_t sync_count, uint32_t pdelay_count, PortState port_state)=0
 Updates IPC values. More...
 

Detailed Description

Generic interface for Inter Process Communication

Member Function Documentation

virtual bool OS_IPC::init ( OS_IPC_ARG arg = NULL)
pure virtual

Initializes the IPC.

Returns
Implementation dependent

Implemented in WindowsNamedPipeIPC, and LinuxSharedMemoryIPC.

virtual bool OS_IPC::update ( int64_t  ml_phoffset,
int64_t  ls_phoffset,
FrequencyRatio  ml_freqoffset,
FrequencyRatio  ls_freq_offset,
uint64_t  local_time,
uint32_t  sync_count,
uint32_t  pdelay_count,
PortState  port_state 
)
pure virtual

Updates IPC values.

Parameters
ml_phoffsetMaster to local phase offset
ls_phoffsetLocal to system phase offset
ml_freqoffsetMaster to local frequency offset
ls_freq_offsetLocal to system frequency offset
local_timeLocal time
sync_countCount of syncs
pdelay_countCount of pdelays
port_statePort's state
Returns
Implementation dependent.

Implemented in WindowsNamedPipeIPC, and LinuxSharedMemoryIPC.


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