carma::ui::rtd::ConnectionRW Class Reference
Class to access connection shared memory object with read/write mode. More...
#include <carma/ui/rtd/common/Connections.h>
Inheritance diagram for carma::ui::rtd::ConnectionRW:
Public Member Functions | |
| ConnectionRW (int pid, const std::string &filename) | |
| Constructor. More... | |
| int | getReloadInProgress () |
| Get the value of the reloadInProgress flag. More... | |
| void | registerWindow (const char *windowName, const char *userName, const char *fullName, const char *location, const char *fullLocation, int guest) |
| Register the window in the connection table. More... | |
| char * | setControl (bool usurp) |
| Usurp or abdicates control; returns a message suitable for logging. More... | |
| void | setPID (int _pid) |
| For backdoor debugging only. More... | |
| void | setReloadInProgress (int state) |
| Set or clear the reloadInProgress flag. More... | |
| void | setUpdateRate (double updateRate) |
| Set window update rate in seconds. More... | |
| void | unregisterDeadWindows () |
| Remove dead processes from the connection table. More... | |
| void | unregisterWindow (int pid) |
| Unregister the window in the connection table. More... | |
| virtual | ~ConnectionRW () |
| 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... | |
| virtual std::string | toString () |
| Dump status of all connections to a string. 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 | |
| ConnectionData * | connection |
| Pointer to a copy of connect database. More... | |
| MemoryMappedFile * | memMap |
| 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 read/write mode.
Definition at line 142 of file Connections.h.
Constructor & Destructor Documentation
| carma::ui::rtd::ConnectionRW::ConnectionRW | ( | int | pid, |
| const std::string & | filename | ||
| ) |
Constructor.
|
virtual |
Destructor.
Definition at line 148 of file Connections.h.
Member Function Documentation
| int carma::ui::rtd::ConnectionRW::getReloadInProgress | ( | ) |
Get the value of the reloadInProgress flag.
| void carma::ui::rtd::ConnectionRW::registerWindow | ( | const char * | windowName, |
| const char * | userName, | ||
| const char * | fullName, | ||
| const char * | location, | ||
| const char * | fullLocation, | ||
| int | guest | ||
| ) |
Register the window in the connection table.
| char* carma::ui::rtd::ConnectionRW::setControl | ( | bool | usurp | ) |
Usurp or abdicates control; returns a message suitable for logging.
| void carma::ui::rtd::ConnectionRW::setPID | ( | int | _pid | ) |
For backdoor debugging only.
| void carma::ui::rtd::ConnectionRW::setReloadInProgress | ( | int | state | ) |
Set or clear the reloadInProgress flag.
| void carma::ui::rtd::ConnectionRW::setUpdateRate | ( | double | updateRate | ) |
Set window update rate in seconds.
| void carma::ui::rtd::ConnectionRW::unregisterDeadWindows | ( | ) |
Remove dead processes from the connection table.
| void carma::ui::rtd::ConnectionRW::unregisterWindow | ( | int | pid | ) |
Unregister the window in the connection table.
The documentation for this class was generated from the following file:
- carma/ui/rtd/common/Connections.h
