oSMbuf Class Reference
[Shared memory buffering]

#include <oSMbuf.hh>

List of all members.

Public Types
typedef std::ios::openmode	openmode_type
typedef std::ios::seekdir	seekdir_type
Public Member Functions
	oSMbuf ()
	oSMbuf (const char *partition, openmode_type mode=std::ios::out)
	Create and open a stream buffer.
	~oSMbuf ()
oSMbuf *	open (const char *partition, openmode_type mode=std::ios::out)
void	close (void)
int	doallocate (void)
int	overflow (int c)
void	set_id (int evtid)
int	underflow ()
int	underflow (int c)
std::streampos	seekoff (std::streamoff off, seekdir_type dir, openmode_type mode)
std::streampos	seekpos (std::streampos pos, openmode_type mode)
int	sync (void)
void	setb (char *b, char *eb, int a=0)
int	out_waiting (void)

---

Detailed Description

This class interfaces the shared memory buffer manager to the output stream class. It is based on the standard template class streambuf, and implements the virtual buffer management functions of streambuf. brief Shared memory output stream class.

Author:

John Zweizig

Version:

1.2; Last Modified March 3, 2008

---

Constructor & Destructor Documentation

oSMbuf::oSMbuf

(

)

Create an unopened stream buffer. brief Default creator.

oSMbuf::oSMbuf	(	const char *	partition,
		openmode_type	mode = std::ios::out
	)

Create and open a stream buffer.

A stream buffer is created and attached to a shared memory partition. Attaching the stream buffer to the memory partition is described in the discussion of open().

oSMbuf::~oSMbuf

(

)

Detach (if necessary) and destroy a stream buffer object.

---

Member Function Documentation

oSMbuf* oSMbuf::open	(	const char *	partition,
		openmode_type	mode = std::ios::out
	)

Attach a stream buffer object to a shared memory partition. The shared memory partition "partition" is found, or created if it does not already exist. A data producer is created for the partition to be used by the stream buffering functions. Buffering of the stream uses the shared memory directly.

void oSMbuf::close

(

void

)

Close and release the output buffer

int oSMbuf::doallocate

(

void

)

Implementation of virtual streambuf::doallocate.

int oSMbuf::overflow

(

int

c

)

Implementation of virtual streambuf::overflow.

void oSMbuf::set_id

(

int

evtid

)

Set the shared memory event id field

int oSMbuf::underflow

(

void

)

[inline]

Implementation of virtual streambuf::underflow.

int oSMbuf::underflow

(

int

c

)

[inline]

Implementation of virtual streambuf::underflow(int).

std::streampos oSMbuf::seekoff	(	std::streamoff	off,
		seekdir_type	dir,
		openmode_type	mode
	)

Implementation of virtual streambuf::seekoff.

std::streampos oSMbuf::seekpos	(	std::streampos	pos,
		openmode_type	mode
	)

Implementation of virtual streambuf::seekoff.

int oSMbuf::sync

(

void

)

Implementation of virtual streambuf::sync.

void oSMbuf::setb	(	char *	b,
		char *	eb,
		int	a = 0
	)			[inline]

Set buffers for obsolete gnu API.

int oSMbuf::out_waiting

(

void

)

[inline]

number of bytes of output data for obsolete gnu API.

---

The documentation for this class was generated from the following file:

• smstream/oSMbuf.hh

---