L4Re Operating System Framework
Interface and Usage Documentation
|
Modules | |
Consumer | |
Producer | |
Functions | |
long | l4shmc_add_chunk (l4shmc_area_t *shmarea, char const *chunk_name, l4_umword_t chunk_capacity, l4shmc_chunk_t *chunk) |
Add a chunk in the shared memory area. | |
long | l4shmc_get_chunk (l4shmc_area_t *shmarea, char const *chunk_name, l4shmc_chunk_t *chunk) |
Get chunk out of shared memory area. | |
long | l4shmc_get_chunk_to (l4shmc_area_t *shmarea, char const *chunk_name, l4_umword_t timeout_ms, l4shmc_chunk_t *chunk) |
Get chunk out of shared memory area, with timeout. | |
long | l4shmc_iterate_chunk (l4shmc_area_t const *shmarea, char const **chunk_name, long offs) |
Iterate over names of all existing chunks. | |
void * | l4shmc_chunk_ptr (l4shmc_chunk_t const *chunk) |
Get data pointer to chunk. | |
long | l4shmc_chunk_capacity (l4shmc_chunk_t const *chunk) |
Get capacity of a chunk. | |
l4shmc_signal_t * | l4shmc_chunk_signal (l4shmc_chunk_t const *chunk) |
Get the registered signal of a chunk. | |
long l4shmc_add_chunk | ( | l4shmc_area_t * | shmarea, |
char const * | chunk_name, | ||
l4_umword_t | chunk_capacity, | ||
l4shmc_chunk_t * | chunk | ||
) |
Add a chunk in the shared memory area.
shmarea | The shared memory area to put the chunk in. | |
chunk_name | Name of the chunk. | |
chunk_capacity | Capacity for payload of the chunk in bytes. | |
[out] | chunk | Chunk structure to fill in. |
0 | Success. |
<0 | Error. |
|
inline |
Get capacity of a chunk.
chunk | Chunk. |
|
inline |
Get data pointer to chunk.
chunk | Chunk. |
|
inline |
Get the registered signal of a chunk.
chunk | Chunk. |
0 | No signal has been registered with this chunk. |
!=0 | Pointer to signal otherwise. |
|
inline |
Get chunk out of shared memory area.
shmarea | Shared memory area. | |
chunk_name | Name of the chunk. | |
[out] | chunk | Chunk data structure to fill. |
0 | Success. |
<0 | Error. |
long l4shmc_get_chunk_to | ( | l4shmc_area_t * | shmarea, |
char const * | chunk_name, | ||
l4_umword_t | timeout_ms, | ||
l4shmc_chunk_t * | chunk | ||
) |
Get chunk out of shared memory area, with timeout.
shmarea | Shared memory area. | |
chunk_name | Name of the chunk. | |
timeout_ms | Timeout in milliseconds to wait for the chunk to appear in the shared memory area. | |
[out] | chunk | Chunk data structure to fill. |
0 | Success. |
<0 | Error. |
long l4shmc_iterate_chunk | ( | l4shmc_area_t const * | shmarea, |
char const ** | chunk_name, | ||
long | offs | ||
) |
Iterate over names of all existing chunks.
shmarea | Shared memory area. |
chunk_name | Where the name of the current chunk will be stored |
offs | 0 to start iteration, return value of previous call to l4shmc_iterate_chunk() to get next chunk |
0 | No more chunks available. |
<0 | Error. |
>0 | Iterator value for the next call. |