#include <unix.h>
Public Member Functions | |
UnixStream (UnixSocket &server, int size=512, bool throwflag=true, timeout_t timeout=0) | |
Create a Unix domain stream by accepting a connection from a bound Unix domain socket acting as a server. | |
UnixStream (const char *pathname, int size=512, bool throwflag=true, timeout_t to=0) | |
Create a Unix domain stream by connecting to a Unix domain socket. | |
void | setTimeout (timeout_t to) |
Set the I/O operation timeout for socket I/O operations. | |
UnixStream (const UnixStream &source) | |
A copy constructor creates a new stream buffer. | |
virtual | ~UnixStream () |
Flush and empty all buffers, and then remove the allocated buffers. | |
int | sync (void) |
Flushes the stream input and output buffers, writes pending output. | |
bool | isPending (Pending pend, timeout_t timeout=TIMEOUT_INF) |
Get the status of pending stream data. | |
int | getBufferSize (void) const |
Return the size of the current stream buffering used. | |
Protected Member Functions | |
UnixStream (bool throwflag=true) | |
The constructor required for "unixstream", a more C++ style version of the TCPStream class. | |
void | allocate (int size) |
Used to allocate the buffer space needed for iostream operations. | |
void | endStream (void) |
Used to terminate the buffer space and cleanup the socket connection. | |
virtual int | underflow (void) |
This streambuf method is used to load the input buffer through the established unix domain socket connection. | |
int | uflow (void) |
This streambuf method is used for doing unbuffered reads through the established unix domain socket connection when in interactive mode. | |
int | overflow (int ch) |
This streambuf method is used to write the output buffer through the established unix domain connection. | |
void | connect (const char *pathname, int size) |
Create a Unix domain stream by connecting to a Unix domain socket. | |
std::iostream * | unixstr (void) |
Used in derived classes to refer to the current object via it's iostream. | |
Protected Attributes | |
timeout_t | timeout |
int | bufsize |
char * | gbuf |
char * | pbuf |
The Unix stream is a C++ "stream" class, and can accept streaming of data to and from other C++ objects using the << and >> operators.
Unix Stream itself can be formed either by connecting to a bound network address of a Unix domain server, or can be created when "accepting" a network connection from a Unix domain server.
ost::UnixStream::UnixStream | ( | bool | throwflag = true |
) | [protected] |
The constructor required for "unixstream", a more C++ style version of the TCPStream class.
ost::UnixStream::UnixStream | ( | UnixSocket & | server, | |
int | size = 512 , |
|||
bool | throwflag = true , |
|||
timeout_t | timeout = 0 | |||
) |
Create a Unix domain stream by accepting a connection from a bound Unix domain socket acting as a server.
This performs an "accept" call.
server | socket listening. | |
size | of streaming input and output buffers. | |
throwflag | flag to throw errors. | |
timeout | for all operations. |
ost::UnixStream::UnixStream | ( | const char * | pathname, | |
int | size = 512 , |
|||
bool | throwflag = true , |
|||
timeout_t | to = 0 | |||
) |
Create a Unix domain stream by connecting to a Unix domain socket.
pathname | path to socket | |
size | of streaming input and output buffers. | |
throwflag | flag to throw errors. | |
to | timeout for all operations. |
ost::UnixStream::UnixStream | ( | const UnixStream & | source | ) |
A copy constructor creates a new stream buffer.
source | of copy. |
virtual ost::UnixStream::~UnixStream | ( | ) | [virtual] |
Flush and empty all buffers, and then remove the allocated buffers.
void ost::UnixStream::allocate | ( | int | size | ) | [protected] |
Used to allocate the buffer space needed for iostream operations.
This function is called by the constructor.
size | of stream buffers from constructor. |
void ost::UnixStream::endStream | ( | void | ) | [protected] |
Used to terminate the buffer space and cleanup the socket connection.
This fucntion is called by the destructor.
virtual int ost::UnixStream::underflow | ( | void | ) | [protected, virtual] |
This streambuf method is used to load the input buffer through the established unix domain socket connection.
int ost::UnixStream::uflow | ( | void | ) | [protected] |
This streambuf method is used for doing unbuffered reads through the established unix domain socket connection when in interactive mode.
Also this method will handle proper use of buffers if not in interative mode.
int ost::UnixStream::overflow | ( | int | ch | ) | [protected] |
This streambuf method is used to write the output buffer through the established unix domain connection.
ch | char to push through. |
void ost::UnixStream::connect | ( | const char * | pathname, | |
int | size | |||
) | [protected] |
Create a Unix domain stream by connecting to a Unix domain socket.
pathname | path to socket | |
size | of streaming input and output buffers. |
Referenced by ost::unixstream::open().
std::iostream* ost::UnixStream::unixstr | ( | void | ) | [inline, protected] |
Used in derived classes to refer to the current object via it's iostream.
For example, to send a set of characters in a derived method, one might use *tcp() << "test".
void ost::UnixStream::setTimeout | ( | timeout_t | to | ) | [inline] |
Set the I/O operation timeout for socket I/O operations.
to | timeout to set. |
References timeout.
int ost::UnixStream::sync | ( | void | ) |
Flushes the stream input and output buffers, writes pending output.
Get the status of pending stream data.
This can be used to examine if input or output is waiting, or if an error or disconnect has occured on the stream. If a read buffer contains data then input is ready and if write buffer contains data it is first flushed and then checked.
Reimplemented from ost::Socket.
int ost::UnixStream::getBufferSize | ( | void | ) | const [inline] |
Return the size of the current stream buffering used.
References bufsize.
timeout_t ost::UnixStream::timeout [protected] |
Referenced by setTimeout().
int ost::UnixStream::bufsize [protected] |
Referenced by getBufferSize().
char* ost::UnixStream::gbuf [protected] |
char * ost::UnixStream::pbuf [protected] |