isc::tcp::TcpMessage Class Reference

Base class for TCP messages. More...

#include <tcp_connection.h>

Inheritance diagram for isc::tcp::TcpMessage:

Public Member Functions
virtual	~TcpMessage ()
	Destructor.
const uint8_t *	getWireData () const
	Returns pointer to the first byte of the wire data.
size_t	getWireDataSize () const
	Returns current size of the wire data.

Protected Attributes
WireData	wire_data_
	Buffer used for data in wire format data.

Detailed Description

Base class for TCP messages.

Definition at line 34 of file tcp_connection.h.

Constructor & Destructor Documentation

~TcpMessage()

virtual isc::tcp::TcpMessage::~TcpMessage ( )

inlinevirtual

Destructor.

Definition at line 37 of file tcp_connection.h.

Member Function Documentation

getWireData()

const uint8_t * isc::tcp::TcpMessage::getWireData ( ) const

inline

Returns pointer to the first byte of the wire data.

Exceptions

InvalidOperation

if wire data is empty (i.e. getWireDataSize() == 0).

Returns

Constant raw pointer to the data.

Definition at line 43 of file tcp_connection.h.

References isc_throw, and wire_data_.

getWireDataSize()

size_t isc::tcp::TcpMessage::getWireDataSize ( ) const

inline

Returns current size of the wire data.

Definition at line 52 of file tcp_connection.h.

References wire_data_.

Member Data Documentation

wire_data_

WireData isc::tcp::TcpMessage::wire_data_

protected

Buffer used for data in wire format data.

Definition at line 58 of file tcp_connection.h.

Referenced by isc::tcp::TcpResponse::consumeWireData(), getWireData(), getWireDataSize(), isc::tcp::TcpStreamRequest::logFormatRequest(), isc::tcp::TcpStreamRequest::needData(), isc::tcp::TcpStreamResponse::pack(), isc::tcp::TcpStreamRequest::postBuffer(), isc::tcp::TcpStreamRequest::unpack(), and isc::tcp::TcpResponse::wireDataAvail().

---

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

• tcp_connection.h