1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00

some doc / whitespace fixes

This commit is contained in:
Georg Reinke 2017-06-08 13:01:23 +02:00
parent 2ba3c1cbe7
commit a495d97242

View file

@ -53,9 +53,9 @@ union shmem_queue {
/** Struct containing all parameters that need to be known when creating a new
* shared memory object. */
struct shmem_conf {
int polling; /*< Whether to use polling instead of POSIX CVs */
int queuelen; /*< Size of the queues (in elements) */
int samplelen; /*< Maximum number of data entries in a single sample */
int polling; /*< Whether to use polling instead of POSIX CVs */
int queuelen; /*< Size of the queues (in elements) */
int samplelen; /*< Maximum number of data entries in a single sample */
};
/** The structure that actually resides in the shared memory. */
@ -70,13 +70,14 @@ struct shmem_shared {
struct pool pool; /**< Pool for the samples in the queues. */
};
/** Main structure representing the shared memory interface. */
struct shmem_int {
void* base; /**< Base address of the mapping (needed for munmap) */
const char* name; /**< Name of the shared memory object */
size_t len; /**< Total size of the shared memory region */
struct shmem_shared *shared; /**< Pointer to mapped shared structure */
int secondary; /**< Set to 1 if this is the secondary user (i.e. not the one
that created the object); 0 otherwise. */
void* base; /**< Base address of the mapping (needed for munmap) */
const char* name; /**< Name of the shared memory object */
size_t len; /**< Total size of the shared memory region */
struct shmem_shared *shared; /**< Pointer to mapped shared structure */
int secondary; /**< Set to 1 if this is the secondary user (i.e. not the one
that created the object); 0 otherwise. */
};
/** Open the shared memory object and retrieve / initialize the shared data structures.