inet::DHCPMessage Class Reference

Class generated from inet/applications/dhcp/DHCPMessage.msg:97 by nedtool. More...

#include <DHCPMessage_m.h>

Inheritance diagram for inet::DHCPMessage:

Public Member Functions
	DHCPMessage (const char *name=nullptr, short kind=0)
	DHCPMessage (const DHCPMessage &other)
virtual	~DHCPMessage ()
DHCPMessage &	operator= (const DHCPMessage &other)
virtual DHCPMessage *	dup () const override
virtual void	parsimPack (omnetpp::cCommBuffer *b) const override
virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override
virtual int	getOp () const
virtual void	setOp (int op)
virtual int	getHtype () const
virtual void	setHtype (int htype)
virtual int	getHlen () const
virtual void	setHlen (int hlen)
virtual int	getHops () const
virtual void	setHops (int hops)
virtual unsigned int	getXid () const
virtual void	setXid (unsigned int xid)
virtual int	getSecs () const
virtual void	setSecs (int secs)
virtual bool	getBroadcast () const
virtual void	setBroadcast (bool broadcast)
virtual IPv4Address &	getCiaddr ()
virtual const IPv4Address &	getCiaddr () const
virtual void	setCiaddr (const IPv4Address &ciaddr)
virtual IPv4Address &	getYiaddr ()
virtual const IPv4Address &	getYiaddr () const
virtual void	setYiaddr (const IPv4Address &yiaddr)
virtual IPv4Address &	getGiaddr ()
virtual const IPv4Address &	getGiaddr () const
virtual void	setGiaddr (const IPv4Address &giaddr)
virtual MACAddress &	getChaddr ()
virtual const MACAddress &	getChaddr () const
virtual void	setChaddr (const MACAddress &chaddr)
virtual const char *	getSname () const
virtual void	setSname (const char *sname)
virtual const char *	getFile () const
virtual void	setFile (const char *file)
virtual DHCPOptions &	getOptions ()
virtual const DHCPOptions &	getOptions () const
virtual void	setOptions (const DHCPOptions &options)

Protected Member Functions
bool	operator== (const DHCPMessage &)

Protected Attributes
int	op
int	htype
int	hlen
int	hops
unsigned int	xid
int	secs
bool	broadcast
IPv4Address	ciaddr
IPv4Address	yiaddr
IPv4Address	giaddr
MACAddress	chaddr
::omnetpp::opp_string	sname
::omnetpp::opp_string	file
DHCPOptions	options

Private Member Functions
void	copy (const DHCPMessage &other)

Detailed Description

Class generated from inet/applications/dhcp/DHCPMessage.msg:97 by nedtool.

//
// Represents a DHCP message. DHCP (Dynamic Host Configuration Protocol, RFC 2131)
// provides a framework for passing configuration information to hosts on a TCP/IP network.
//
// @see DHCPClient, DHCPServer
//
packet DHCPMessage
{
    int op @enum(DHCPOpcode); // message op code / message type. 1 = BOOTREQUEST, 2 = BOOTREPLY
    int htype; // hardware address type, see ARP section in "Assigned Numbers" RFC; e.g., '1' = 10mb ethernet
    int hlen; // hardware address length (e.g.  '6' for 10mb ethernet)
    int hops; // client sets to zero, optionally used by relay agents when booting via a relay agent
    unsigned int xid; // transaction ID, a random number chosen by the client, used by the client and server to associate messages and responses between a client and a server
    int secs; // filled in by client, seconds elapsed since client began address acquisition or renewal process
    bool broadcast; // the broadcast bit in the flags field
    IPv4Address ciaddr; // client IP address; only filled in if client is in BOUND, RENEW or REBINDING state and can respond to ARP requests
    IPv4Address yiaddr; // 'your' (client) IP address
    IPv4Address giaddr; // relay agent IP address, used in booting via a relay agent
    MACAddress chaddr; // client hardware address (MAC)
    string sname; // optional server host name
    string file; // boot file name (unused in the simulation)
    DHCPOptions options; // holds DHCP options
}

Constructor & Destructor Documentation

inet::DHCPMessage::DHCPMessage	(	const char *	name = nullptr,
		short	kind = 0
	)

inet::DHCPMessage::DHCPMessage

(

const DHCPMessage &

other

)

virtual inet::DHCPMessage::~DHCPMessage ( )

virtual

Member Function Documentation

void inet::DHCPMessage::copy ( const DHCPMessage &  other )

private

virtual DHCPMessage* inet::DHCPMessage::dup ( ) const

inlineoverridevirtual

{return new DHCPMessage(*this);}

virtual bool inet::DHCPMessage::getBroadcast ( ) const

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPServer::sendNAK(), and inet::DHCPServer::sendOffer().

virtual MACAddress& inet::DHCPMessage::getChaddr ( )

virtual

Referenced by inet::DHCPServer::processDHCPMessage(), and inet::DHCPServer::sendNAK().

virtual const MACAddress& inet::DHCPMessage::getChaddr ( ) const

inlinevirtual

Referenced by getChaddr().

{return const_cast<DHCPMessage*>(this)->getChaddr();}

virtual IPv4Address& inet::DHCPMessage::getCiaddr ( )

virtual

Referenced by inet::DHCPServer::processDHCPMessage(), inet::DHCPServer::sendACK(), and inet::DHCPServer::sendOffer().

virtual const IPv4Address& inet::DHCPMessage::getCiaddr ( ) const

inlinevirtual

Referenced by getCiaddr().

{return const_cast<DHCPMessage*>(this)->getCiaddr();}

virtual const char* inet::DHCPMessage::getFile ( ) const

virtual

virtual IPv4Address& inet::DHCPMessage::getGiaddr ( )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPServer::sendNAK(), and inet::DHCPServer::sendOffer().

virtual const IPv4Address& inet::DHCPMessage::getGiaddr ( ) const

inlinevirtual

Referenced by getGiaddr().

{return const_cast<DHCPMessage*>(this)->getGiaddr();}

virtual int inet::DHCPMessage::getHlen ( ) const

virtual

virtual int inet::DHCPMessage::getHops ( ) const

virtual

virtual int inet::DHCPMessage::getHtype ( ) const

virtual

virtual int inet::DHCPMessage::getOp ( ) const

virtual

Referenced by inet::DHCPClient::handleDHCPMessage(), and inet::DHCPServer::processDHCPMessage().

virtual DHCPOptions& inet::DHCPMessage::getOptions ( )

virtual

Referenced by inet::DHCPClient::handleDHCPMessage(), inet::DHCPServer::processDHCPMessage(), inet::DHCPClient::recordLease(), inet::DHCPClient::recordOffer(), inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual const DHCPOptions& inet::DHCPMessage::getOptions ( ) const

inlinevirtual

Referenced by getOptions().

{return const_cast<DHCPMessage*>(this)->getOptions();}

virtual int inet::DHCPMessage::getSecs ( ) const

virtual

virtual const char* inet::DHCPMessage::getSname ( ) const

virtual

virtual unsigned int inet::DHCPMessage::getXid ( ) const

virtual

Referenced by inet::DHCPClient::handleDHCPMessage(), inet::DHCPServer::processDHCPMessage(), and inet::DHCPServer::sendNAK().

virtual IPv4Address& inet::DHCPMessage::getYiaddr ( )

virtual

Referenced by inet::DHCPClient::handleDHCPMessage(), inet::DHCPClient::recordLease(), and inet::DHCPClient::recordOffer().

virtual const IPv4Address& inet::DHCPMessage::getYiaddr ( ) const

inlinevirtual

Referenced by getYiaddr().

{return const_cast<DHCPMessage*>(this)->getYiaddr();}

DHCPMessage& inet::DHCPMessage::operator=

(

const DHCPMessage &

other

)

bool inet::DHCPMessage::operator== ( const DHCPMessage &  )

protected

virtual void inet::DHCPMessage::parsimPack ( omnetpp::cCommBuffer *  b ) const

overridevirtual

Referenced by inet::doParsimPacking().

virtual void inet::DHCPMessage::parsimUnpack ( omnetpp::cCommBuffer *  b )

overridevirtual

Referenced by inet::doParsimUnpacking().

virtual void inet::DHCPMessage::setBroadcast ( bool  broadcast )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setChaddr ( const MACAddress &  chaddr )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setCiaddr ( const IPv4Address &  ciaddr )

virtual

Referenced by inet::DHCPServer::sendACK(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setFile ( const char *  file )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setGiaddr ( const IPv4Address &  giaddr )

virtual

Referenced by inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setHlen ( int  hlen )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setHops ( int  hops )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setHtype ( int  htype )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setOp ( int  op )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setOptions ( const DHCPOptions &  options )

virtual

virtual void inet::DHCPMessage::setSecs ( int  secs )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setSname ( const char *  sname )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setXid ( unsigned int  xid )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPClient::sendDecline(), inet::DHCPClient::sendDiscover(), inet::DHCPServer::sendNAK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPMessage::setYiaddr ( const IPv4Address &  yiaddr )

virtual

Referenced by inet::DHCPServer::sendACK(), inet::DHCPServer::sendOffer(), and inet::DHCPClient::sendRequest().

Member Data Documentation

bool inet::DHCPMessage::broadcast

protected

MACAddress inet::DHCPMessage::chaddr

protected

IPv4Address inet::DHCPMessage::ciaddr

protected

::omnetpp::opp_string inet::DHCPMessage::file

protected

IPv4Address inet::DHCPMessage::giaddr

protected

int inet::DHCPMessage::hlen

protected

int inet::DHCPMessage::hops

protected

int inet::DHCPMessage::htype

protected

int inet::DHCPMessage::op

protected

DHCPOptions inet::DHCPMessage::options

protected

int inet::DHCPMessage::secs

protected

::omnetpp::opp_string inet::DHCPMessage::sname

protected

unsigned int inet::DHCPMessage::xid

protected

IPv4Address inet::DHCPMessage::yiaddr

protected

---

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

• DHCPMessage_m.h