Inheritance diagram for PPTClient:

Collaboration diagram for PPTClient:

Public Member Functions
virtual void	brokenPipe ()

virtual void	closeConnection ()

virtual void	dump (std::ostream &strm) const
	dumps information about this object

std::string	exit () override

virtual std::ostream *	getOutputStream ()

unsigned int	getRecvChunkSize () override

unsigned int	getSendChunkSize () override

virtual Socket *	getSocket ()

virtual void	initConnection ()

virtual bool	isConnected ()

	PPTClient (const string &hostStr, int portVal, int timeout)

	PPTClient (const string &unix_socket, int timeout)

bool	receive (std::map< std::string, std::string > &extensions, std::ostream *strm=nullptr) override
	receive a chunk of either extensions into the specified map or data into the specified stream

void	send (const std::string &buffer, std::map< std::string, std::string > &extensions) override
	Send a message to the server.

void	sendExit () override
	Send the exit token as an extension.

void	sendExtensions (std::map< std::string, std::string > &extensions) override
	send the specified extensions

virtual void	setOutputStream (std::ostream *strm)

Protected Member Functions
virtual void	read_extensions (std::map< std::string, std::string > &extensions, const std::string &xstr)
	the string passed are extensions, read them and store the name/value pairs into the passed map

virtual int	readBuffer (char *inBuff, const unsigned int buff_size)
	read a buffer of data from the socket

virtual int	readBufferNonBlocking (char *inBuff, const int buff_size)
	read a buffer of data from the socket without blocking

void	send (const std::string &buffer) override
	sends the buffer to the socket

Protected Attributes
bool	_brokenPipe = false

Socket *	_mySock = nullptr

std::ostream *	_out = nullptr

Detailed Description

Definition at line 40 of file PPTClient.h.

Member Function Documentation

◆ brokenPipe()

virtual void Connection::brokenPipe ( )

inlinevirtualinherited

Definition at line 87 of file Connection.h.

◆ closeConnection()

virtual void PPTClient::closeConnection ( )

virtual

Implements PPTConnection.

◆ dump()

virtual void PPTClient::dump ( std::ostream & strm ) const

virtual

dumps information about this object

Displays the pointer value of this instance

Parameters

strm	C++ i/o stream to dump the information to

Reimplemented from Connection.

◆ exit()

std::string PPTConnection::exit ( )

inlineoverridevirtualinherited

Implements Connection.

Definition at line 70 of file PPTConnection.h.

◆ getOutputStream()

virtual std::ostream * Connection::getOutputStream ( )

inlinevirtualinherited

Definition at line 82 of file Connection.h.

◆ getRecvChunkSize()

unsigned int PPTConnection::getRecvChunkSize ( )

overridevirtualinherited

Implements Connection.

Definition at line 455 of file PPTConnection.cc.

◆ getSendChunkSize()

unsigned int PPTConnection::getSendChunkSize ( )

overridevirtualinherited

Implements Connection.

Definition at line 460 of file PPTConnection.cc.

◆ getSocket()

virtual Socket * Connection::getSocket ( )

inlinevirtualinherited

Definition at line 67 of file Connection.h.

◆ initConnection()

virtual void PPTClient::initConnection ( )

virtual

Implements PPTConnection.

◆ isConnected()

virtual bool Connection::isConnected ( )

inlinevirtualinherited

Definition at line 72 of file Connection.h.

◆ read_extensions()

void PPTConnection::read_extensions	(	std::map< std::string, std::string > &	extensions,
		const std::string &	xstr )

protectedvirtualinherited

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.

Parameters

extensions	map to store the name/value pairs in
xstr	string of extensions in the form *(name[=value];)

Definition at line 378 of file PPTConnection.cc.

◆ readBuffer()

int PPTConnection::readBuffer	(	char *	buffer,
		const unsigned int	buffer_size )

protectedvirtualinherited

read a buffer of data from the socket

Parameters

buffer	buffer to store the data received from the socket in
buffer_size	max size of the data to be received

Returns: number of bytes actually read

Definition at line 202 of file PPTConnection.cc.

◆ readBufferNonBlocking()

int PPTConnection::readBufferNonBlocking	(	char *	inBuff,
		const int	buffer_size )

protectedvirtualinherited

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.

Parameters

inBuff	buffer to store the data into
buffer_size	the size of the passed buffer

Returns: number of bytes read in, -1 if failed to read anything

Definition at line 426 of file PPTConnection.cc.

◆ receive()

bool PPTConnection::receive	(	std::map< std::string, std::string > &	extensions,
		std::ostream *	strm = nullptr )

overridevirtualinherited

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 7 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.

Parameters

extensions	map to store the name/value paris into
strm	output stream to write the received data into

Returns: true if what was received is the last chunk, false otherwise

Implements Connection.

Definition at line 251 of file PPTConnection.cc.

◆ send() [1/2]

void PPTConnection::send ( const std::string & buffer )

overrideprotectedvirtualinherited

sends the buffer to the socket

the buffer includes the length, extensions, data, whatever is to be sent

Parameters

buffer data buffer to send to the socket

Implements Connection.

Definition at line 190 of file PPTConnection.cc.

◆ send() [2/2]

void PPTConnection::send	(	const std::string &	buffer,
		std::map< std::string, std::string > &	extensions )

overridevirtualinherited

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     = 8HEX
last-chunk     = 7("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

Parameters

buffer	buffer of data to send
extensions	list of name/value pairs sent

Implements Connection.

Definition at line 109 of file PPTConnection.cc.

◆ sendExit()

void PPTConnection::sendExit ( )

overridevirtualinherited

Send the exit token as an extension.

Implements Connection.

Definition at line 125 of file PPTConnection.cc.

◆ sendExtensions()

void PPTConnection::sendExtensions ( std::map< std::string, std::string > & extensions )

overridevirtualinherited

send the specified extensions

Parameters

extensions name/value paris to be sent

Implements Connection.

Definition at line 162 of file PPTConnection.cc.

◆ setOutputStream()

virtual void Connection::setOutputStream ( std::ostream * strm )

inlinevirtualinherited

Definition at line 78 of file Connection.h.

Member Data Documentation

◆ _brokenPipe

bool Connection::_brokenPipe = false

protectedinherited

Definition at line 47 of file Connection.h.

◆ _mySock

Socket* Connection::_mySock = nullptr

protectedinherited

Definition at line 45 of file Connection.h.

◆ _out

std::ostream* Connection::_out = nullptr

protectedinherited

Definition at line 46 of file Connection.h.

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

PPTClient.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ brokenPipe()

◆ closeConnection()

◆ dump()

◆ exit()

◆ getOutputStream()

◆ getRecvChunkSize()

◆ getSendChunkSize()

◆ getSocket()

◆ initConnection()

◆ isConnected()

◆ read_extensions()

◆ readBuffer()

◆ readBufferNonBlocking()

◆ receive()

◆ send() [1/2]

◆ send() [2/2]

◆ sendExit()

◆ sendExtensions()

◆ setOutputStream()

Member Data Documentation

◆ _brokenPipe

◆ _mySock

◆ _out