isc::lease_query::BlqMsg Class Reference

Lease Query specific wrapper around DHCPx packet. More...

#include <blq_msg.h>

Inheritance diagram for isc::lease_query::BlqMsg:

Public Member Functions
	BlqMsg (dhcp::PktPtr pkt)
	Constructor.
virtual	~BlqMsg ()
	Destructor.
dhcp::PktPtr	getPkt () const
	Returns a pointer to the DHCPx packet.
tcp::WireData &	getWireData ()
	Returns a reference to the wire data.
size_t	getWireSize () const
	Returns size of the packed wire data.
Xid	getXid () const
	Returns the transaction id.
void	pack ()
	Packs the packet into wire form ready for TCP transmission.
void	setXid (const Xid &xid)
	Sets the transaction id.

Protected Attributes
dhcp::PktPtr	pkt_
	The DHCP(4/6) packet containing the query.
tcp::WireData	wire_data_
	Holds the TCP stream wire form of the query.

Detailed Description

Lease Query specific wrapper around DHCPx packet.

The class is intended as a wrapper around DHCP<4/6> packets to isolate lease query infrastructure from protocol specifics as well as provide an opportunity to house and add lease query specifics.

Definition at line 24 of file blq_msg.h.

Constructor & Destructor Documentation

BlqMsg()

isc::lease_query::BlqMsg::BlqMsg ( dhcp::PktPtr pkt )

inline

Constructor.

Parameters

pkt	Pointer to the DHCPx lease query packet

Definition at line 29 of file blq_msg.h.

References isc_throw, and pkt_.

Referenced by isc::lease_query::BlqQuery::BlqQuery(), and isc::lease_query::BlqResponse::BlqResponse().

~BlqMsg()

virtual isc::lease_query::BlqMsg::~BlqMsg ( )

inlinevirtual

Destructor.

Definition at line 37 of file blq_msg.h.

Member Function Documentation

getPkt()

dhcp::PktPtr isc::lease_query::BlqMsg::getPkt ( ) const

inline

Returns a pointer to the DHCPx packet.

Definition at line 53 of file blq_msg.h.

References pkt_.

Referenced by isc::lease_query::BlqQuery::getQuery(), and isc::lease_query::BlqResponse::getResponse().

getWireData()

tcp::WireData & isc::lease_query::BlqMsg::getWireData ( )

inline

Returns a reference to the wire data.

Definition at line 80 of file blq_msg.h.

References wire_data_.

getWireSize()

size_t isc::lease_query::BlqMsg::getWireSize ( ) const

inline

Returns size of the packed wire data.

Definition at line 75 of file blq_msg.h.

References wire_data_.

getXid()

Xid isc::lease_query::BlqMsg::getXid ( ) const

inline

Returns the transaction id.

Definition at line 41 of file blq_msg.h.

References pkt_.

pack()

void isc::lease_query::BlqMsg::pack ( )

inline

Packs the packet into wire form ready for TCP transmission.

Definition at line 58 of file blq_msg.h.

References pkt_, and wire_data_.

setXid()

void isc::lease_query::BlqMsg::setXid ( const Xid & xid )

inline

Sets the transaction id.

Parameters

xid	new transaction id

Definition at line 48 of file blq_msg.h.

References pkt_.

Member Data Documentation

pkt_

dhcp::PktPtr isc::lease_query::BlqMsg::pkt_

protected

The DHCP(4/6) packet containing the query.

Definition at line 86 of file blq_msg.h.

Referenced by BlqMsg(), getPkt(), getXid(), pack(), and setXid().

wire_data_

tcp::WireData isc::lease_query::BlqMsg::wire_data_

protected

Holds the TCP stream wire form of the query.

Definition at line 89 of file blq_msg.h.

Referenced by getWireData(), getWireSize(), and pack().

---

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

• blq_msg.h