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

#include <linux_hal_common.hpp>

Inheritance diagram for LinuxSharedMemoryIPC:
Inheritance graph
Collaboration diagram for LinuxSharedMemoryIPC:
Collaboration graph

Public Member Functions

 LinuxSharedMemoryIPC ()
 
 ~LinuxSharedMemoryIPC ()
 
virtual bool init (OS_IPC_ARG *barg=NULL)
 Initializes shared memory with DEFAULT_GROUPNAME case arg is null. More...
 
virtual bool update (int64_t ml_phoffset, int64_t ls_phoffset, FrequencyRatio ml_freqoffset, FrequencyRatio ls_freqoffset, uint64_t local_time, uint32_t sync_count, uint32_t pdelay_count, PortState port_state)
 Updates IPC values. More...
 
void stop ()
 unmaps and unlink shared memory More...
 

Detailed Description

Linux shared memory interface

Constructor & Destructor Documentation

LinuxSharedMemoryIPC::LinuxSharedMemoryIPC ( )
inline

Initializes the internal flags

LinuxSharedMemoryIPC::~LinuxSharedMemoryIPC ( )

Destroys and unlinks shared memory

Member Function Documentation

virtual bool LinuxSharedMemoryIPC::init ( OS_IPC_ARG barg = NULL)
virtual

Initializes shared memory with DEFAULT_GROUPNAME case arg is null.

Parameters
bargGroupname of the shared memory
Returns
TRUE if no error, FALSE otherwise

Implements OS_IPC.

void LinuxSharedMemoryIPC::stop ( )

unmaps and unlink shared memory

Returns
void
virtual bool LinuxSharedMemoryIPC::update ( int64_t  ml_phoffset,
int64_t  ls_phoffset,
FrequencyRatio  ml_freqoffset,
FrequencyRatio  ls_freqoffset,
uint64_t  local_time,
uint32_t  sync_count,
uint32_t  pdelay_count,
PortState  port_state 
)
virtual

Updates IPC values.

Parameters
ml_phoffsetMaster to local phase offset
ls_phoffsetLocal to slave phase offset
ml_freqoffsetMaster to local frequency offset
ls_freqoffsetLocal to slave frequency offset
local_timeLocal time
sync_countCount of syncs
pdelay_countCount of pdelays
port_statePort's state
Returns
TRUE

Implements OS_IPC.


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