SharedMemory class.
More...
#include <SharedMemory.h>
◆ SharedMemory() [1/2]
| coil::SharedMemory::SharedMemory |
( |
| ) |
|
◆ ~SharedMemory()
| virtual coil::SharedMemory::~SharedMemory |
( |
| ) |
|
|
virtual |
◆ SharedMemory() [2/2]
| coil::SharedMemory::SharedMemory |
( |
const SharedMemory & |
rhs | ) |
|
Copy Constructor.
Copy Constructor
- Parameters
-
| rhs | shared memory object of copy source. |
◆ close()
| virtual int coil::SharedMemory::close |
( |
| ) |
|
|
virtual |
Close Shared Memory.
- Returns
- 0: successful, -1: failed
◆ create()
| virtual int coil::SharedMemory::create |
( |
std::string |
shm_address, |
|
|
int |
memory_size = DEFAULT_MEMORY_SIZE |
|
) |
| |
|
virtual |
Create Shared Memory.
- Parameters
-
- Returns
- 0: successful, -1: failed
◆ created()
| virtual bool coil::SharedMemory::created |
( |
| ) |
|
|
virtual |
◆ get_addresss()
| virtual std::string coil::SharedMemory::get_addresss |
( |
| ) |
|
|
virtual |
◆ get_data()
| virtual char* coil::SharedMemory::get_data |
( |
| ) |
|
|
virtual |
◆ get_size()
| virtual unsigned int coil::SharedMemory::get_size |
( |
| ) |
|
|
virtual |
◆ open()
| virtual int coil::SharedMemory::open |
( |
std::string |
shm_address, |
|
|
int |
memory_size = DEFAULT_MEMORY_SIZE |
|
) |
| |
|
virtual |
Open Shared Memory.
- Parameters
-
- Returns
- 0: successful, -1: failed
◆ operator=()
Assignment operator.
Copy a shared memory object.
- Parameters
-
| rhs | shared memory object of assignment source. |
- Returns
- Assignment result.
◆ read()
| virtual int coil::SharedMemory::read |
( |
char * |
data, |
|
|
const int |
pos, |
|
|
const int |
size |
|
) |
| |
|
virtual |
Read Shared Memory.
- Parameters
-
- Returns
- 0: successful, -1: failed
◆ unlink()
| virtual int coil::SharedMemory::unlink |
( |
| ) |
|
|
virtual |
- Returns
- 0: successful, -1: failed
◆ write()
| virtual int coil::SharedMemory::write |
( |
const char * |
data, |
|
|
const int |
pos, |
|
|
const int |
size |
|
) |
| |
|
virtual |
Write Shared Memory.
- Parameters
-
- Returns
- 0: successful, -1: failed
The documentation for this class was generated from the following file:
- /home/n-ando/work/OpenRTM-aist/branches/RELENG_1_2/OpenRTM-aist/src/lib/coil/include/coil/SharedMemory.h