isc::tcp::TcpResponse Class Reference

Abstract class used to create and send an outbound response. More...

#include <tcp_connection.h>

Inheritance diagram for isc::tcp::TcpResponse:

Public Member Functions
	TcpResponse ()
	Constructor.
virtual	~TcpResponse ()
	Destructor.
virtual void	consumeWireData (const size_t length)
	Erases n bytes from the beginning of the wire data.
virtual const uint8_t *	getWireData () const
	Returns pointer to the first byte of the wire data.
virtual size_t	getWireDataSize () const
	Returns current size of the wire data.
virtual void	pack ()=0
	Prepares the wire data content for writing.
bool	sendInProgress ()
bool	wireDataAvail () const
	Checks if the output buffer contains some data to be sent.
Public Member Functions inherited from isc::tcp::TcpMessage
virtual	~TcpMessage ()=default
	Destructor.

Additional Inherited Members
Protected Member Functions inherited from isc::tcp::TcpMessage
const uint8_t *	getWireData (size_t position) const
	Returns pointer to current byte of the wire data.
size_t	getWireDataSize (size_t position) const
	Returns current size of the wire data.
Protected Attributes inherited from isc::tcp::TcpMessage
size_t	position_
	Position in the data.
WireData	wire_data_
	Buffer used for data in wire format data.

Detailed Description

Abstract class used to create and send an outbound response.

Definition at line 129 of file tcp_connection.h.

Constructor & Destructor Documentation

TcpResponse()

isc::tcp::TcpResponse::TcpResponse ( )

inline

Constructor.

Definition at line 132 of file tcp_connection.h.

~TcpResponse()

virtual isc::tcp::TcpResponse::~TcpResponse ( )

inlinevirtual

Destructor.

Definition at line 135 of file tcp_connection.h.

Member Function Documentation

consumeWireData()

virtual void isc::tcp::TcpResponse::consumeWireData ( const size_t length )

inlinevirtual

Erases n bytes from the beginning of the wire data.

Parameters

length

Number of bytes to be erased.

Definition at line 162 of file tcp_connection.h.

References isc::tcp::TcpMessage::wire_data_.

getWireData()

virtual const uint8_t * isc::tcp::TcpResponse::getWireData ( ) const

inlinevirtual

Returns pointer to the first byte of the wire data.

Implements isc::tcp::TcpMessage.

Definition at line 138 of file tcp_connection.h.

References isc::tcp::TcpMessage::getWireData().

Here is the call graph for this function:

getWireDataSize()

virtual size_t isc::tcp::TcpResponse::getWireDataSize ( ) const

inlinevirtual

Returns current size of the wire data.

Implements isc::tcp::TcpMessage.

Definition at line 143 of file tcp_connection.h.

References isc::tcp::TcpMessage::getWireDataSize().

Here is the call graph for this function:

pack()

virtual void isc::tcp::TcpResponse::pack ( )

pure virtual

Prepares the wire data content for writing.

Implemented in isc::tcp::TcpStreamResponse.

sendInProgress()

bool isc::tcp::TcpResponse::sendInProgress ( )

inline

Definition at line 171 of file tcp_connection.h.

wireDataAvail()

bool isc::tcp::TcpResponse::wireDataAvail ( ) const

inline

Checks if the output buffer contains some data to be sent.

Returns

true if the output buffer contains data to be sent, false otherwise.

Definition at line 152 of file tcp_connection.h.

References isc::tcp::TcpMessage::wire_data_.

---

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

• tcp_connection.h