Kea 2.5.7
isc::tcp::TcpResponse Class Referenceabstract

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

Additional Inherited Members

- Protected Attributes inherited from isc::tcp::TcpMessage
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 103 of file tcp_connection.h.

Constructor & Destructor Documentation

◆ TcpResponse()

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

Constructor.

Definition at line 106 of file tcp_connection.h.

◆ ~TcpResponse()

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

Destructor.

Definition at line 110 of file tcp_connection.h.

Member Function Documentation

◆ consumeWireData()

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

Erases n bytes from the beginning of the wire data.

Parameters
lengthNumber of bytes to be erased.

Definition at line 37 of file tcp_connection.cc.

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

◆ 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 129 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 117 of file tcp_connection.h.

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


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