Typedefs | |
typedef struct apr_shm_t | apr_shm_t |
Functions | |
apr_status_t | apr_shm_create (apr_shm_t **m, apr_size_t reqsize, const char *filename, apr_pool_t *pool) |
apr_status_t | apr_shm_remove (const char *filename, apr_pool_t *pool) |
apr_status_t | apr_shm_destroy (apr_shm_t *m) |
apr_status_t | apr_shm_attach (apr_shm_t **m, const char *filename, apr_pool_t *pool) |
apr_status_t | apr_shm_detach (apr_shm_t *m) |
void * | apr_shm_baseaddr_get (const apr_shm_t *m) |
apr_size_t | apr_shm_size_get (const apr_shm_t *m) |
apr_pool_t * | apr_shm_pool_get (const apr_shm_t *theshm) |
Private, platform-specific data struture representing a shared memory segment.
apr_status_t apr_shm_attach | ( | apr_shm_t ** | m, | |
const char * | filename, | |||
apr_pool_t * | pool | |||
) |
Attach to a shared memory segment that was created by another process.
m | The shared memory structure to create. | |
filename | The file used to create the original segment. (This MUST match the original filename.) | |
pool | the pool from which to allocate the shared memory structure for this process. |
void* apr_shm_baseaddr_get | ( | const apr_shm_t * | m | ) |
Retrieve the base address of the shared memory segment. NOTE: This address is only usable within the callers address space, since this API does not guarantee that other attaching processes will maintain the same address mapping.
m | The shared memory segment from which to retrieve the base address. |
apr_status_t apr_shm_create | ( | apr_shm_t ** | m, | |
apr_size_t | reqsize, | |||
const char * | filename, | |||
apr_pool_t * | pool | |||
) |
Create and make accessable a shared memory segment.
m | The shared memory structure to create. | |
reqsize | The desired size of the segment. | |
filename | The file to use for shared memory on platforms that require it. | |
pool | the pool from which to allocate the shared memory structure. |
A note about allocation sizes: On some platforms it is necessary to store some metainformation about the segment within the actual segment. In order to supply the caller with the requested size it may be necessary for the implementation to request a slightly greater segment length from the subsystem. In all cases, the apr_shm_baseaddr_get() function will return the first usable byte of memory.
apr_status_t apr_shm_destroy | ( | apr_shm_t * | m | ) |
Destroy a shared memory segment and associated memory.
m | The shared memory segment structure to destroy. |
apr_status_t apr_shm_detach | ( | apr_shm_t * | m | ) |
Detach from a shared memory segment without destroying it.
m | The shared memory structure representing the segment to detach from. |
apr_pool_t* apr_shm_pool_get | ( | const apr_shm_t * | theshm | ) |
Get the pool used by this shared memory segment.
apr_status_t apr_shm_remove | ( | const char * | filename, | |
apr_pool_t * | pool | |||
) |
Remove named resource associated with a shared memory segment, preventing attachments to the resource, but not destroying it.
filename | The filename associated with shared-memory segment which needs to be removed | |
pool | The pool used for file operations |
apr_size_t apr_shm_size_get | ( | const apr_shm_t * | m | ) |
Retrieve the length of a shared memory segment in bytes.
m | The shared memory segment from which to retrieve the segment length. |