LSMP_buffer Struct Reference
[Shared memory buffering]

#include <lsmp_int.hh>

List of all members.

Public Member Functions

bool inUse (void) const
bool seen (void) const
bool queued (void) const

Public Attributes

unsigned int status
long boff
ConFlags reserve_mask
ConFlags seen_mask
int use_count
int ldata
 Length of data in buffer.
int trig
 Trigger mask.
time_t fill_time
 Time associated with the data.
LSMP::eventid_type data_ID
 data id.
pid_t owner_pid
 Process identifier associated with this consumer.
int link
 Link to the next buffer in the free queue.
int evt_count
 Number of times the buffer has been refilled.


Detailed Description

Ligo share memory buffer class contains information about the buffers managed by the LSMP software.
Author:
John Zweizig
Version:
2.1; Last Modified March 3, 2008

Member Function Documentation

bool LSMP_buffer::inUse ( void   )  const [inline]

Test whether the buffer is in use.

bool LSMP_buffer::seen ( void   )  const [inline]

Test whether the buffer has been seen

bool LSMP_buffer::queued ( void   )  const [inline]

Test whether the buffer is in the free queue.


Member Data Documentation

unsigned int LSMP_buffer::status

Buffer status flag word.

long LSMP_buffer::boff

Buffer offset in bytes from the start of the shared memory partition.

ConFlags LSMP_buffer::reserve_mask

Bit mask containing one bit per consumer and is used to indicate which consumers have reserved the buffer. brief Mask of consumers that have reserved the buffer.

ConFlags LSMP_buffer::seen_mask

Bit mask containing one bit per consumer and is used to prevent a buffer. The seen_mask bit for a given consumer is set in LSMP_CONS::get_buffer() when the buffer is allocated to a consumer or when it is skipped by the setNSkip() mechanism. The entire seen_mask is cleared when a buffer is returned or released (for distribution) by a producer. brief Mask of consumers that have seen the buffer.

int LSMP_buffer::use_count

The use count indicates the number of consumers that have reserved or allocated the buffer. The use count is zeroed when the partition is constructed or when the buffer is released or returned by a producer. The count is decremented when a consumer frees the buffer or a consumer to which the buffer is allocated is deleted, and it is incremented when buffer is allocated by a consumer. brief Number of consumers reserving this buffer.


The documentation for this struct was generated from the following file:
Generated on Sun Mar 8 19:21:09 2009 for dmt by  doxygen 1.5.4