Specialization of the Network object for DHCPv6 case. More...

#include <network.h>

Inheritance diagram for isc::dhcp::Network6:

Public Member Functions
	Network6 ()
	Constructor. More...

OptionPtr	getInterfaceId () const
	Returns interface-id value (if specified) More...

Triplet< uint32_t >	getPreferred () const
	Returns preferred lifetime (in seconds) More...

bool	getRapidCommit () const
	Returns boolean value indicating that the Rapid Commit option is supported or unsupported for the subnet. More...

void	setInterfaceId (const OptionPtr &ifaceid)
	sets interface-id option (if defined) More...

void	setPreferred (const Triplet< uint32_t > &preferred)
	Sets new preferred lifetime for a network. More...

void	setRapidCommit (const bool rapid_commit)
	Enables or disables Rapid Commit option support for the subnet. More...

virtual data::ElementPtr	toElement () const
	Unparses network object. More...

Public Member Functions inherited from isc::dhcp::Network
	Network ()
	Constructor. More...

virtual	~Network ()
	Virtual destructor. More...

void	addRelayAddress (const asiolink::IOAddress &addr)
	Adds an address to the list addresses in the network's relay info. More...

void	allowClientClass (const isc::dhcp::ClientClass &class_name)
	Sets the supported class to class class_name. More...

virtual bool	clientSupported (const isc::dhcp::ClientClasses &client_classes) const
	Checks whether this network supports client that belongs to specified classes. More...

CfgOptionPtr	getCfgOption ()
	Returns pointer to the option data configuration for this subnet. More...

ConstCfgOptionPtr	getCfgOption () const
	Returns const pointer to the option data configuration for this subnet. More...

const isc::dhcp::ClientClass &	getClientClass () const
	returns the client class More...

HRMode	getHostReservationMode () const
	Specifies what type of Host Reservations are supported. More...

std::string	getIface () const
	Returns name of the local interface for which this network is selected. More...

const IOAddressList &	getRelayAddresses () const
	Returns the list of relay addresses from the network's relay info. More...

const RelayInfo &	getRelayInfo () const
	Returns const reference to relay information. More...

const isc::dhcp::ClientClasses &	getRequiredClasses () const
	Returns classes which are required to be evaluated. More...

Triplet< uint32_t >	getT1 () const
	Returns T1 (renew timer), expressed in seconds. More...

Triplet< uint32_t >	getT2 () const
	Returns T2 (rebind timer), expressed in seconds. More...

Triplet< uint32_t >	getValid () const
	Return valid-lifetime for addresses in that prefix. More...

bool	hasRelayAddress (const asiolink::IOAddress &address) const
	Tests if the network's relay info contains the given address. More...

bool	hasRelays () const
	Indicates if network's relay info has relay addresses. More...

void	requireClientClass (const isc::dhcp::ClientClass &class_name)
	Adds class class_name to classes required to be evaluated. More...

void	setHostReservationMode (HRMode mode)
	Sets host reservation mode. More...

void	setIface (const std::string &iface_name)
	Sets local name of the interface for which this network is selected. More...

void	setRelayInfo (const RelayInfo &relay)
	Sets information about relay. More...

void	setT1 (const Triplet< uint32_t > &t1)
	Sets new renew timer for a network. More...

void	setT2 (const Triplet< uint32_t > &t2)
	Sets new rebind timer for a network. More...

void	setValid (const Triplet< uint32_t > &valid)
	Sets new valid lifetime for a network. More...

Public Member Functions inherited from isc::data::StampedElement
	StampedElement ()
	Constructor. More...

boost::posix_time::ptime	getModificationTime () const
	Returns timestamp. More...

void	setModificationTime (const boost::posix_time::ptime &timestamp)
	Sets timestamp to the explicitly provided value. More...

void	updateModificationTime ()
	Sets timestmp to the current time. More...

Public Member Functions inherited from isc::data::UserContext
void	contextToElement (data::ElementPtr map) const
	Merge unparse a user_context object. More...

data::ConstElementPtr	getContext () const
	Returns const pointer to the user context. More...

void	setContext (const data::ConstElementPtr &ctx)
	Sets user context. More...

Public Member Functions inherited from isc::data::CfgToElement
virtual	~CfgToElement ()
	Destructor. More...

Additional Inherited Members
Public Types inherited from isc::dhcp::Network
enum	HRMode { HR_DISABLED, HR_OUT_OF_POOL, HR_GLOBAL, HR_ALL }
	Specifies allowed host reservation mode. More...

typedef boost::shared_ptr< Network::RelayInfo >	RelayInfoPtr
	Pointer to the RelayInfo structure. More...

Static Public Member Functions inherited from isc::data::UserContext
static data::ElementPtr	toElement (data::ConstElementPtr map)
	Copy extracting comments an Element map. More...

Protected Attributes inherited from isc::dhcp::Network
CfgOptionPtr	cfg_option_
	Pointer to the option data configuration for this subnet. More...

ClientClass	client_class_
	Optional definition of a client class. More...

HRMode	host_reservation_mode_
	Specifies host reservation mode. More...

std::string	iface_name_
	Holds interface name for which this network is selected. More...

RelayInfo	relay_
	Relay information. More...

ClientClasses	required_classes_
	Required classes. More...

Triplet< uint32_t >	t1_
	a Triplet (min/default/max) holding allowed renew timer values More...

Triplet< uint32_t >	t2_
	a Triplet (min/default/max) holding allowed rebind timer values More...

Triplet< uint32_t >	valid_
	a Triplet (min/default/max) holding allowed valid lifetime values More...

Protected Attributes inherited from isc::data::UserContext
data::ConstElementPtr	user_context_
	Pointer to the user context (may be NULL) More...

Detailed Description

Specialization of the Network object for DHCPv6 case.

Definition at line 431 of file network.h.

Constructor & Destructor Documentation

◆ Network6()

isc::dhcp::Network6::Network6 ( )

inline

Constructor.

Definition at line 435 of file network.h.

Member Function Documentation

◆ getInterfaceId()

OptionPtr isc::dhcp::Network6::getInterfaceId ( ) const

inline

Returns interface-id value (if specified)

Returns: interface-id option (if defined)

Definition at line 456 of file network.h.

◆ getPreferred()

Triplet<uint32_t> isc::dhcp::Network6::getPreferred ( ) const

inline

Returns preferred lifetime (in seconds)

Returns: a triplet with preferred lifetime

Definition at line 442 of file network.h.

◆ getRapidCommit()

bool isc::dhcp::Network6::getRapidCommit ( ) const

inline

Returns boolean value indicating that the Rapid Commit option is supported or unsupported for the subnet.

Returns: true if the Rapid Commit option is supported, false otherwise.

Definition at line 471 of file network.h.

◆ setInterfaceId()

void isc::dhcp::Network6::setInterfaceId ( const OptionPtr & ifaceid )

inline

sets interface-id option (if defined)

Parameters

ifaceid pointer to interface-id option

Definition at line 463 of file network.h.

Referenced by isc::dhcp::Subnet6ConfigParser::initSubnet().

◆ setPreferred()

void isc::dhcp::Network6::setPreferred ( const Triplet< uint32_t > & preferred )

inline

Sets new preferred lifetime for a network.

Parameters

preferred New preferred lifetime in seconds.

Definition at line 449 of file network.h.

Referenced by isc::dhcp::Subnet6::Subnet6().

◆ setRapidCommit()

void isc::dhcp::Network6::setRapidCommit ( const bool rapid_commit )

inline

Enables or disables Rapid Commit option support for the subnet.

Parameters

rapid_commit A boolean value indicating that the Rapid Commit option support is enabled (if true), or disabled (if false).

Definition at line 479 of file network.h.

Referenced by isc::dhcp::Subnet6ConfigParser::initSubnet().

◆ toElement()

ElementPtr isc::dhcp::Network6::toElement ( ) const

virtual

Unparses network object.

Returns: A pointer to unparsed network configuration.

Reimplemented from isc::dhcp::Network.

Reimplemented in isc::dhcp::Subnet6, and isc::dhcp::SharedNetwork6.

Definition at line 220 of file network.cc.

Referenced by isc::dhcp::Subnet6::toElement().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Network6()

Member Function Documentation

◆ getInterfaceId()

◆ getPreferred()

◆ getRapidCommit()

◆ setInterfaceId()

◆ setPreferred()

◆ setRapidCommit()

◆ toElement()