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

#include <DHCPMessage_m.h>

Inheritance diagram for inet::DHCPOptions:

Public Member Functions
	DHCPOptions ()

	DHCPOptions (const DHCPOptions &other)

virtual	~DHCPOptions ()

DHCPOptions &	operator= (const DHCPOptions &other)

virtual DHCPOptions *	dup () const override

virtual void	parsimPack (omnetpp::cCommBuffer *b) const override

virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override

virtual int	getMessageType () const

virtual void	setMessageType (int messageType)

virtual const char *	getHostName () const

virtual void	setHostName (const char *hostName)

virtual void	setParameterRequestListArraySize (unsigned int size)

virtual unsigned int	getParameterRequestListArraySize () const

virtual int	getParameterRequestList (unsigned int k) const

virtual void	setParameterRequestList (unsigned int k, int parameterRequestList)

virtual MACAddress &	getClientIdentifier ()

virtual const MACAddress &	getClientIdentifier () const

virtual void	setClientIdentifier (const MACAddress &clientIdentifier)

virtual IPv4Address &	getRequestedIp ()

virtual const IPv4Address &	getRequestedIp () const

virtual void	setRequestedIp (const IPv4Address &requestedIp)

virtual IPv4Address &	getSubnetMask ()

virtual const IPv4Address &	getSubnetMask () const

virtual void	setSubnetMask (const IPv4Address &subnetMask)

virtual void	setRouterArraySize (unsigned int size)

virtual unsigned int	getRouterArraySize () const

virtual IPv4Address &	getRouter (unsigned int k)

virtual const IPv4Address &	getRouter (unsigned int k) const

virtual void	setRouter (unsigned int k, const IPv4Address &router)

virtual void	setDnsArraySize (unsigned int size)

virtual unsigned int	getDnsArraySize () const

virtual IPv4Address &	getDns (unsigned int k)

virtual const IPv4Address &	getDns (unsigned int k) const

virtual void	setDns (unsigned int k, const IPv4Address &dns)

virtual void	setNtpArraySize (unsigned int size)

virtual unsigned int	getNtpArraySize () const

virtual IPv4Address &	getNtp (unsigned int k)

virtual const IPv4Address &	getNtp (unsigned int k) const

virtual void	setNtp (unsigned int k, const IPv4Address &ntp)

virtual IPv4Address &	getServerIdentifier ()

virtual const IPv4Address &	getServerIdentifier () const

virtual void	setServerIdentifier (const IPv4Address &serverIdentifier)

virtual ::omnetpp::simtime_t	getRenewalTime () const

virtual void	setRenewalTime (::omnetpp::simtime_t renewalTime)

virtual ::omnetpp::simtime_t	getRebindingTime () const

virtual void	setRebindingTime (::omnetpp::simtime_t rebindingTime)

virtual ::omnetpp::simtime_t	getLeaseTime () const

virtual void	setLeaseTime (::omnetpp::simtime_t leaseTime)

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

Protected Attributes
int	messageType

::omnetpp::opp_string	hostName

int *	parameterRequestList

unsigned int	parameterRequestList_arraysize

MACAddress	clientIdentifier

IPv4Address	requestedIp

IPv4Address	subnetMask

IPv4Address *	router

unsigned int	router_arraysize

IPv4Address *	dns

unsigned int	dns_arraysize

IPv4Address *	ntp

unsigned int	ntp_arraysize

IPv4Address	serverIdentifier

::omnetpp::simtime_t	renewalTime

::omnetpp::simtime_t	rebindingTime

::omnetpp::simtime_t	leaseTime

Private Member Functions
void	copy (const DHCPOptions &other)

Detailed Description

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

//
// Represents options in a DHCP message. In the DHCP protocol, options are
// added to the message as tagged data items. In the simulation, this DHCPOptions
// class statically holds the union of all options actually used by the DHCP
// protocol models. Options absent from a packet are represented by empty/unfilled
// DHCPOptions fields.
//
// @see DHCPMessage, DHCPClient, DHCPServer
//
class DHCPOptions
{
    int messageType @enum(DHCPMessageType); // to convey the type of the DHCP message
    string hostName; // name of the client
    int parameterRequestList[]; // used by a DHCP client to request values for specified configuration parameters
    MACAddress clientIdentifier; // used by DHCP clients to specify their unique identifier
    IPv4Address requestedIp; // used in a client request (DHCPDISCOVER) to allow the client to request that a particular IP address be assigned
    IPv4Address subnetMask; // client's subnet mask
    IPv4Address router[]; // IP addresses for routers on the client's subnet
    IPv4Address dns[]; // list of DNSs available to the client
    IPv4Address ntp[]; // list of IP addresses indicating NTP servers available to the client
    IPv4Address serverIdentifier; // client use this field as the destination address for any unicast DHCP messages to the server
    simtime_t renewalTime; // time interval (T1) from address assignment until the client transitions to the RENEWING state
    simtime_t rebindingTime; // time interval (T2) from address assignment until the client transitions to the REBINDING state
    simtime_t leaseTime; // request for lease time (client), offered lease time (server)
}

Constructor & Destructor Documentation

inet::DHCPOptions::DHCPOptions ( )

inet::DHCPOptions::DHCPOptions ( const DHCPOptions & other )

virtual inet::DHCPOptions::~DHCPOptions ( )

virtual

Member Function Documentation

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

private

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

inlineoverridevirtual

183 {return new DHCPOptions(*this);}

inet::DHCPOptions::DHCPOptions

DHCPOptions()

virtual MACAddress& inet::DHCPOptions::getClientIdentifier ( )

virtual

virtual const MACAddress& inet::DHCPOptions::getClientIdentifier ( ) const

inlinevirtual

Referenced by getClientIdentifier().

197 {return const_cast<DHCPOptions*>(this)->getClientIdentifier();}

inet::DHCPOptions::DHCPOptions

DHCPOptions()

inet::DHCPOptions::getClientIdentifier

virtual MACAddress & getClientIdentifier()

virtual IPv4Address& inet::DHCPOptions::getDns ( unsigned int k )

virtual

Referenced by inet::DHCPClient::recordLease().

virtual const IPv4Address& inet::DHCPOptions::getDns ( unsigned int k ) const

inlinevirtual

Referenced by getDns().

213 {return const_cast<DHCPOptions*>(this)->getDns(k);}

inet::DHCPOptions::getDns

virtual IPv4Address & getDns(unsigned int k)

inet::DHCPOptions::DHCPOptions

DHCPOptions()

inet::physicallayer::k

const double k

Definition: QAM16Modulation.cc:24

virtual unsigned int inet::DHCPOptions::getDnsArraySize ( ) const

virtual

Referenced by inet::DHCPClient::recordLease().

virtual const char* inet::DHCPOptions::getHostName ( ) const

virtual

virtual ::omnetpp::simtime_t inet::DHCPOptions::getLeaseTime ( ) const

Referenced by inet::DHCPClient::recordLease().

virtual int inet::DHCPOptions::getMessageType ( ) const

virtual

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

virtual IPv4Address& inet::DHCPOptions::getNtp ( unsigned int k )

virtual

Referenced by inet::DHCPClient::recordLease().

virtual const IPv4Address& inet::DHCPOptions::getNtp ( unsigned int k ) const

inlinevirtual

Referenced by getNtp().

218 {return const_cast<DHCPOptions*>(this)->getNtp(k);}

inet::DHCPOptions::DHCPOptions

DHCPOptions()

inet::DHCPOptions::getNtp

virtual IPv4Address & getNtp(unsigned int k)

inet::physicallayer::k

const double k

Definition: QAM16Modulation.cc:24

virtual unsigned int inet::DHCPOptions::getNtpArraySize ( ) const

virtual

Referenced by inet::DHCPClient::recordLease().

virtual int inet::DHCPOptions::getParameterRequestList ( unsigned int k ) const

virtual

virtual unsigned int inet::DHCPOptions::getParameterRequestListArraySize ( ) const

virtual

virtual ::omnetpp::simtime_t inet::DHCPOptions::getRebindingTime ( ) const

Referenced by inet::DHCPClient::recordLease().

virtual ::omnetpp::simtime_t inet::DHCPOptions::getRenewalTime ( ) const

Referenced by inet::DHCPClient::recordLease().

virtual IPv4Address& inet::DHCPOptions::getRequestedIp ( )

virtual

Referenced by inet::DHCPServer::processDHCPMessage().

virtual const IPv4Address& inet::DHCPOptions::getRequestedIp ( ) const

inlinevirtual

Referenced by getRequestedIp().

200 {return const_cast<DHCPOptions*>(this)->getRequestedIp();}

inet::DHCPOptions::DHCPOptions

DHCPOptions()

inet::DHCPOptions::getRequestedIp

virtual IPv4Address & getRequestedIp()

virtual IPv4Address& inet::DHCPOptions::getRouter ( unsigned int k )

virtual

Referenced by inet::DHCPClient::recordLease().

virtual const IPv4Address& inet::DHCPOptions::getRouter ( unsigned int k ) const

inlinevirtual

Referenced by getRouter().

208 {return const_cast<DHCPOptions*>(this)->getRouter(k);}

inet::DHCPOptions::DHCPOptions

DHCPOptions()

inet::physicallayer::k

const double k

Definition: QAM16Modulation.cc:24

inet::DHCPOptions::getRouter

virtual IPv4Address & getRouter(unsigned int k)

virtual unsigned int inet::DHCPOptions::getRouterArraySize ( ) const

virtual

Referenced by inet::DHCPClient::recordLease().

virtual IPv4Address& inet::DHCPOptions::getServerIdentifier ( )

virtual

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

virtual const IPv4Address& inet::DHCPOptions::getServerIdentifier ( ) const

inlinevirtual

Referenced by getServerIdentifier().

221 {return const_cast<DHCPOptions*>(this)->getServerIdentifier();}

inet::DHCPOptions::DHCPOptions

DHCPOptions()

inet::DHCPOptions::getServerIdentifier

virtual IPv4Address & getServerIdentifier()

virtual IPv4Address& inet::DHCPOptions::getSubnetMask ( )

virtual

Referenced by inet::DHCPClient::recordLease().

virtual const IPv4Address& inet::DHCPOptions::getSubnetMask ( ) const

inlinevirtual

Referenced by getSubnetMask().

203 {return const_cast<DHCPOptions*>(this)->getSubnetMask();}

inet::DHCPOptions::DHCPOptions

DHCPOptions()

inet::DHCPOptions::getSubnetMask

virtual IPv4Address & getSubnetMask()

DHCPOptions& inet::DHCPOptions::operator= ( const DHCPOptions & other )

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

protected

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

overridevirtual

Referenced by inet::doParsimPacking().

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

overridevirtual

Referenced by inet::doParsimUnpacking().

virtual void inet::DHCPOptions::setClientIdentifier ( const MACAddress & clientIdentifier )

virtual

Referenced by inet::DHCPClient::sendDiscover(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPOptions::setDns	(	unsigned int	k,
		const IPv4Address &	dns
	)

virtual

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

virtual void inet::DHCPOptions::setDnsArraySize ( unsigned int size )

virtual

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

virtual void inet::DHCPOptions::setHostName ( const char * hostName )

virtual

virtual void inet::DHCPOptions::setLeaseTime ( ::omnetpp::simtime_t leaseTime )

virtual

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

virtual void inet::DHCPOptions::setMessageType ( int messageType )

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::DHCPOptions::setNtp	(	unsigned int	k,
		const IPv4Address &	ntp
	)

virtual

virtual void inet::DHCPOptions::setNtpArraySize ( unsigned int size )

virtual

virtual void inet::DHCPOptions::setParameterRequestList	(	unsigned int	k,
		int	parameterRequestList
	)

virtual

Referenced by inet::DHCPClient::sendDiscover(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPOptions::setParameterRequestListArraySize ( unsigned int size )

virtual

Referenced by inet::DHCPClient::sendDiscover(), and inet::DHCPClient::sendRequest().

virtual void inet::DHCPOptions::setRebindingTime ( ::omnetpp::simtime_t rebindingTime )

virtual

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

virtual void inet::DHCPOptions::setRenewalTime ( ::omnetpp::simtime_t renewalTime )

virtual

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

virtual void inet::DHCPOptions::setRequestedIp ( const IPv4Address & requestedIp )

virtual

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

virtual void inet::DHCPOptions::setRouter	(	unsigned int	k,
		const IPv4Address &	router
	)

virtual

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

virtual void inet::DHCPOptions::setRouterArraySize ( unsigned int size )

virtual

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

virtual void inet::DHCPOptions::setServerIdentifier ( const IPv4Address & serverIdentifier )

virtual

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

virtual void inet::DHCPOptions::setSubnetMask ( const IPv4Address & subnetMask )

virtual

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

Member Data Documentation

MACAddress inet::DHCPOptions::clientIdentifier

protected

IPv4Address* inet::DHCPOptions::dns

protected

unsigned int inet::DHCPOptions::dns_arraysize

protected

::omnetpp::opp_string inet::DHCPOptions::hostName

protected

::omnetpp::simtime_t inet::DHCPOptions::leaseTime

protected

int inet::DHCPOptions::messageType

protected

IPv4Address* inet::DHCPOptions::ntp

protected

unsigned int inet::DHCPOptions::ntp_arraysize

protected

int* inet::DHCPOptions::parameterRequestList

protected

unsigned int inet::DHCPOptions::parameterRequestList_arraysize

protected

::omnetpp::simtime_t inet::DHCPOptions::rebindingTime

protected

::omnetpp::simtime_t inet::DHCPOptions::renewalTime

protected

IPv4Address inet::DHCPOptions::requestedIp

protected

IPv4Address* inet::DHCPOptions::router

protected

unsigned int inet::DHCPOptions::router_arraysize

protected

IPv4Address inet::DHCPOptions::serverIdentifier

protected

IPv4Address inet::DHCPOptions::subnetMask

protected

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

DHCPMessage_m.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation