Fairport  v1.0.38
fairport::node_stream_device Class Reference

Defines a stream device for a node for use by boost iostream. More...

#include <node.h>

+ Inheritance diagram for fairport::node_stream_device:
+ Collaboration diagram for fairport::node_stream_device:

List of all members.

Public Member Functions

 node_stream_device ()
 Default construct the node stream device.
std::streamsize read (char *pbuffer, std::streamsize n)
 Read data from this node into the buffer at the current position.
std::streampos seek (boost::iostreams::stream_offset off, std::ios_base::seekdir way)
 Move the current position in the stream.

Friends

class node

Detailed Description

Defines a stream device for a node for use by boost iostream.

The boost iostream library requires that one defines a device, which implements a few key operations. This is the device for streaming out of a node.

Definition at line 243 of file node.h.


Constructor & Destructor Documentation

fairport::node_stream_device::node_stream_device ( ) [inline]

Default construct the node stream device.

Definition at line 247 of file node.h.


Member Function Documentation

std::streamsize fairport::node_stream_device::read ( char *  pbuffer,
std::streamsize  n 
) [inline]

Read data from this node into the buffer at the current position.

Parameters:
[out]pbufferThe buffer to store the results into
[in]nThe amount of data to read
Returns:
The amount of data read

Definition at line 840 of file node.h.

std::streampos fairport::node_stream_device::seek ( boost::iostreams::stream_offset  off,
std::ios_base::seekdir  way 
) [inline]

Move the current position in the stream.

Parameters:
[in]offThe offset to move the current position
[in]wayThe location to move the current position from
Returns:
The new position

Definition at line 851 of file node.h.


Friends And Related Function Documentation

friend class node [friend]

Definition at line 262 of file node.h.


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