#include <PPTConnection.h>
Public Member Functions | |
virtual | ~PPTConnection () |
virtual void | initConnection ()=0 |
virtual void | closeConnection ()=0 |
virtual string | exit () |
virtual void | send (const string &buffer, map< string, string > &extensions) |
Send a message to the server. | |
virtual void | sendExtensions (map< string, string > &extensions) |
send the specified extensions | |
virtual void | sendExit () |
Send the exit token as an extension. | |
virtual bool | receive (map< string, string > &extensions, ostream *strm=0) |
receive a chunk of either extensions into the specified map or data into the specified stream | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual Socket * | getSocket () |
virtual bool | isConnected () |
virtual void | setOutputStream (ostream *strm) |
virtual ostream * | getOutputStream () |
virtual void | brokenPipe () |
Protected Member Functions | |
PPTConnection (int timeout) | |
virtual int | readBuffer (char *inBuff, unsigned int buff_size) |
read a buffer of data from the socket | |
virtual int | readBufferNonBlocking (char *inBuff) |
read a buffer of data from the socket without blocking | |
virtual void | send (const string &buffer) |
sends the buffer to the socket | |
virtual void | sendChunk (const string &buffer, map< string, string > &extensions) |
Send a chunk to the server. | |
virtual void | read_extensions (map< string, string > &extensions, const string &xstr) |
the string passed are extensions, read them and store the name/value pairs into the passed map | |
virtual void | receive (ostream &strm, unsigned short len) |
receive from the socket the number of bytes specified until done | |
Protected Attributes | |
Socket * | _mySock |
ostream * | _out |
bool | _brokenPipe |
PPTConnection::PPTConnection | ( | int | timeout | ) | [inline, protected] |
virtual PPTConnection::~PPTConnection | ( | ) | [inline, virtual] |
int PPTConnection::readBuffer | ( | char * | buffer, | |
unsigned int | buffer_size | |||
) | [protected, virtual] |
read a buffer of data from the socket
buffer | buffer to store the data received from the socket in | |
buffer_size | max size of the data to be received |
References Connection::_mySock, and Socket::receive().
Referenced by readBufferNonBlocking(), and receive().
int PPTConnection::readBufferNonBlocking | ( | char * | inBuff | ) | [protected, virtual] |
read a buffer of data from the socket without blocking
Try to read a buffer of data without blocking. We will try _timeout times, waiting 1000 milliseconds between each try. The variable _timeout is passed into the constructor.
inBuff | buffer to store the data into |
References Connection::getSocket(), Socket::getSocketDescriptor(), PPT_PROTOCOL_BUFFER_SIZE, and readBuffer().
Referenced by PPTClient::initConnection().
void PPTConnection::send | ( | const string & | buffer | ) | [protected, virtual] |
sends the buffer to the socket
the buffer includes the length, extensions, data, whatever is to be sent
buffer | data buffer to send to the socket |
Implements Connection.
References Connection::_mySock, Socket::send(), and Socket::sync().
Referenced by CmdClient::executeCommand(), PPTClient::initConnection(), sendChunk(), sendExit(), and sendExtensions().
void PPTConnection::sendChunk | ( | const string & | buffer, | |
map< string, string > & | extensions | |||
) | [protected, virtual] |
Send a chunk to the server.
A chunk is either the chunk with the data or the last-chunk
buffer | The data buffer to send | |
extensions | name/value pairs to send |
Implements Connection.
References send(), and sendExtensions().
Referenced by send().
void PPTConnection::read_extensions | ( | map< string, string > & | extensions, | |
const string & | xstr | |||
) | [protected, virtual] |
the string passed are extensions, read them and store the name/value pairs into the passed map
It has already been determined that extensions were read in the chunk. Deconstruct the name/value pairs and store them into the map passed. Each extension ends with a semicolon.
extensions | map to store the name/value pairs in | |
xstr | string of extensions in the form *(name[=value];) |
Referenced by receive().
void PPTConnection::receive | ( | ostream & | strm, | |
unsigned short | len | |||
) | [protected, virtual] |
receive from the socket the number of bytes specified until done
This method receives data from the socket until there is nothing more to be read
strm | output stream to write what is received to | |
len | number of bytes remaining to be read |
References PPT_PROTOCOL_BUFFER_SIZE, and readBuffer().
Referenced by CmdClient::executeCommand(), and receive().
virtual void PPTConnection::initConnection | ( | ) | [pure virtual] |
virtual void PPTConnection::closeConnection | ( | ) | [pure virtual] |
virtual string PPTConnection::exit | ( | ) | [inline, virtual] |
void PPTConnection::send | ( | const string & | buffer, | |
map< string, string > & | extensions | |||
) | [virtual] |
Send a message to the server.
Sends the specified message buffer to the server followed by a buffer of length 0 to signify the end of the message
A buffer sent to the server will follow the following form:
Chunked-Body = chunk-extensions chunk last-chunk chunk-extensions= chunk-size 'x' *( chunk-ext-name [ "=" chunk-ext-val ] ; chunk = chunk-size 'd' chunk-data chunk-size = 4HEX last-chunk = 4("0") d chunk-ext-name = token chunk-ext-val = token | quoted-string chunk-data = chunk-size(OCTET)
If there are extensions then they are sent first. The length of the extensions is sent first, followed by the character 'x', and then the extensions in the format name[=value];
Then the buffer itself is sent. The length of the buffer is sent followed by the character 'd' signifying data is being transmitted.
if the buffer is empty then this represents the last chunk
buffer | buffer of data to send | |
extensions | list of name/value pairs sent |
Implements Connection.
References sendChunk().
void PPTConnection::sendExtensions | ( | map< string, string > & | extensions | ) | [virtual] |
send the specified extensions
extensions | name/value paris to be sent |
Implements Connection.
References send().
Referenced by sendChunk().
void PPTConnection::sendExit | ( | ) | [virtual] |
Send the exit token as an extension.
Implements Connection.
References PPTProtocol::PPT_EXIT_NOW, and send().
Referenced by PPTClient::closeConnection().
bool PPTConnection::receive | ( | map< string, string > & | extensions, | |
ostream * | strm = 0 | |||
) | [virtual] |
receive a chunk of either extensions into the specified map or data into the specified stream
This receive will read a chunk of information from the socket and determine if what is read are extensions, where they are stored in the extensions map passed, or data, which is written to the specified stream
The first 4 bytes is the length of the information that was passed. The 5th character is either the character 'x', signifying that extensions were sent, or 'd', signifying that data was sent.
extensions | map to store the name/value paris into | |
strm | output stream to write the received data into |
Implements Connection.
References Connection::_out, PPT_PROTOCOL_BUFFER_SIZE, read_extensions(), readBuffer(), and receive().
void PPTConnection::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance
strm | C++ i/o stream to dump the information to |
Reimplemented from Connection.
Reimplemented in PPTClient, and PPTServer.
References Connection::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
Referenced by PPTServer::dump(), and PPTClient::dump().
virtual Socket* Connection::getSocket | ( | ) | [inline, virtual, inherited] |
virtual bool Connection::isConnected | ( | ) | [inline, virtual, inherited] |
References Connection::_mySock, and Socket::isConnected().
Referenced by CmdClient::isConnected().
virtual void Connection::setOutputStream | ( | ostream * | strm | ) | [inline, virtual, inherited] |
References Connection::_out.
virtual ostream* Connection::getOutputStream | ( | ) | [inline, virtual, inherited] |
References Connection::_out.
virtual void Connection::brokenPipe | ( | ) | [inline, virtual, inherited] |
Socket* Connection::_mySock [protected, inherited] |
ostream* Connection::_out [protected, inherited] |
Referenced by Connection::dump(), Connection::getOutputStream(), receive(), and Connection::setOutputStream().
bool Connection::_brokenPipe [protected, inherited] |
Referenced by Connection::brokenPipe(), PPTClient::closeConnection(), and Connection::dump().