shmem.h File Reference

#include <stdlib.h>
#include <stdbool.h>
#include <pthread.h>

Include dependency graph for shmem.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	shmem_sync_t
struct	shmem_handler_t
struct	shmem_props_t

Enumerations
enum	shmem_state_t { SHMEM_READY , SHMEM_BUSY , SHMEM_MAINTENANCE }
enum	{ SHMEM_SYNC_VERSION = 3 }
enum	{ SHM_NAME_LENGTH = 64 }
enum	{ SHMEM_VERSION_IGNORE = 0 }

Functions
shmem_handler_t *	shmem_init (void **shdata, const shmem_props_t *shmem_props)
void	shmem_finalize (shmem_handler_t *handler, bool(*is_empty_fn)(void))
void	shmem_lock (shmem_handler_t *handler)
void	shmem_unlock (shmem_handler_t *handler)
void	shmem_lock_maintenance (shmem_handler_t *handler)
void	shmem_unlock_maintenance (shmem_handler_t *handler)
void	shmem_acquire_busy (shmem_handler_t *handler)
void	shmem_release_busy (shmem_handler_t *handler)
char *	get_shm_filename (shmem_handler_t *handler)
bool	shmem_exists (const char *shmem_module, const char *shmem_key)
void	shmem_destroy (const char *shmem_module, const char *shmem_key)
int	shmem_shsync__version (void)
size_t	shmem_shsync__size (void)

Enumeration Type Documentation

shmem_state_t

enum shmem_state_t

Enumerator
SHMEM_READY
SHMEM_BUSY
SHMEM_MAINTENANCE

anonymous enum

anonymous enum

Enumerator
SHMEM_SYNC_VERSION

anonymous enum

anonymous enum

Enumerator
SHM_NAME_LENGTH

anonymous enum

anonymous enum

Enumerator
SHMEM_VERSION_IGNORE

Function Documentation

shmem_init()

shmem_handler_t * shmem_init	(	void **	shdata,
		const shmem_props_t *	shmem_props
	)

shmem_finalize()

void shmem_finalize	(	shmem_handler_t *	handler,
		bool(*)(void)	is_empty_fn
	)

shmem_lock()

void shmem_lock

(

shmem_handler_t *

handler

)

shmem_unlock()

void shmem_unlock

(

shmem_handler_t *

handler

)

shmem_lock_maintenance()

void shmem_lock_maintenance

(

shmem_handler_t *

handler

)

shmem_unlock_maintenance()

void shmem_unlock_maintenance

(

shmem_handler_t *

handler

)

shmem_acquire_busy()

void shmem_acquire_busy

(

shmem_handler_t *

handler

)

shmem_release_busy()

void shmem_release_busy

(

shmem_handler_t *

handler

)

get_shm_filename()

char * get_shm_filename

(

shmem_handler_t *

handler

)

shmem_exists()

bool shmem_exists	(	const char *	shmem_module,
		const char *	shmem_key
	)

shmem_destroy()

void shmem_destroy	(	const char *	shmem_module,
		const char *	shmem_key
	)

shmem_shsync__version()

int shmem_shsync__version

(

void

)

shmem_shsync__size()

size_t shmem_shsync__size

(

void

)