CARMA C++
carma::ui::rtd::ConnectionRO Class Reference

Class to access connection shared memory object with readonly mode. More...

#include <carma/ui/rtd/common/Connections.h>

Inheritance diagram for carma::ui::rtd::ConnectionRO:
carma::ui::rtd::ConnectionBase

Public Member Functions

 ConnectionRO (int pid, const std::string &filename)
 Constructor. More...
 
int getCacheSerialNumber ()
 Get the serial number for the cached data (debugging) More...
 
ConnectionDatagetConnectionData ()
 This method gets the connectionData from cache (refreshing if necessary) More...
 
CnxgetThisCnx ()
 This method gets the current cnx from cache (refreshing if necessary) More...
 
std::string toString ()
 Return state of this object as a string. More...
 
virtual ~ConnectionRO ()
 Destructor. More...
 
- Public Member Functions inherited from carma::ui::rtd::ConnectionBase
 ConnectionBase (int pid, const std::string &filename, MemoryMappedFile::Protection_t p)
 Constructor. More...
 
int getMaxConnections ()
 Return the maximum number of connections possible. More...
 
int getSerialNumber ()
 Get the serial number of this data set (debugging) More...
 
void lockRead ()
 Lock connection database shared memory for read access. More...
 
void lockWrite ()
 Lock connection database shared memory for read access. More...
 
void unlock ()
 Release lock on connection database shared memory. More...
 
virtual ~ConnectionBase ()
 Destructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from carma::ui::rtd::ConnectionBase
ConnectionDataconnection
 Pointer to a copy of connect database. More...
 
MemoryMappedFilememMap
 Pointer to the memory mapped file that contains connection database. More...
 
std::string memoryMappedFilename
 Filename of connection database. More...
 
int pid_
 Process id for this connection. More...
 

Detailed Description

Class to access connection shared memory object with readonly mode.

Definition at line 182 of file Connections.h.

Constructor & Destructor Documentation

carma::ui::rtd::ConnectionRO::ConnectionRO ( int  pid,
const std::string &  filename 
)

Constructor.

virtual carma::ui::rtd::ConnectionRO::~ConnectionRO ( )
virtual

Destructor.

Definition at line 187 of file Connections.h.

Member Function Documentation

int carma::ui::rtd::ConnectionRO::getCacheSerialNumber ( )

Get the serial number for the cached data (debugging)

ConnectionData* carma::ui::rtd::ConnectionRO::getConnectionData ( )

This method gets the connectionData from cache (refreshing if necessary)

Cnx* carma::ui::rtd::ConnectionRO::getThisCnx ( )

This method gets the current cnx from cache (refreshing if necessary)

std::string carma::ui::rtd::ConnectionRO::toString ( )
virtual

Return state of this object as a string.

Reimplemented from carma::ui::rtd::ConnectionBase.


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