isc::data::UserContext Struct Reference

Base class for user context. More...

#include <user_context.h>

Inheritance diagram for isc::data::UserContext:

Public Member Functions
void	contextToElement (data::ElementPtr map) const
	Merge unparse a user_context object.
data::ConstElementPtr	getContext () const
	Returns const pointer to the user context.
void	setContext (const data::ConstElementPtr &ctx)
	Sets user context.

Static Public Member Functions
static data::ElementPtr	toElement (data::ConstElementPtr map)
	Copy an Element map.

Protected Attributes
data::ConstElementPtr	user_context_
	Pointer to the user context (may be NULL)

Detailed Description

Base class for user context.

Many configuration structures allow attaching and storing arbitrary user data that we call user context. Each of those configuration structures need to derive from this class or include this class to handle user context.

Definition at line 22 of file user_context.h.

Member Function Documentation

contextToElement()

void isc::data::UserContext::contextToElement

(

data::ElementPtr

map

)

const

Merge unparse a user_context object.

Add user-context to map, but only if defined. Omit if it was not.

Parameters

map	A pointer to map where the user context will be unparsed.

Definition at line 15 of file user_context.cc.

References getContext().

Referenced by isc::dhcp::OptionDefinition::contextToElement(), isc::agent::CtrlAgentCfgContext::toElement(), isc::d2::D2CfgContext::toElement(), isc::d2::TSIGKeyInfo::toElement(), isc::d2::DnsServerInfo::toElement(), isc::d2::DdnsDomain::toElement(), isc::dhcp::CfgDUID::toElement(), isc::dhcp::CfgIface::toElement(), isc::dhcp::ClientClassDef::toElement(), isc::dhcp::D2ClientConfig::toElement(), isc::dhcp::Lease4::toElement(), isc::dhcp::Lease6::toElement(), isc::dhcp::Network::toElement(), isc::dhcp::Pool::toElement(), isc::dhcp::SrvConfig::toElement(), isc::dhcp::Subnet::toElement(), isc::http::BasicHttpAuthClient::toElement(), isc::http::BasicHttpAuthConfig::toElement(), isc::process::LoggingInfo::toElement(), isc::netconf::NetconfConfig::toElement(), isc::netconf::CfgControlSocket::toElement(), isc::netconf::CfgServer::toElement(), isc::dhcp::Host::toElement4(), and isc::dhcp::Host::toElement6().

Here is the call graph for this function:

getContext()

data::ConstElementPtr isc::data::UserContext::getContext ( ) const

inline

Returns const pointer to the user context.

Definition at line 24 of file user_context.h.

References user_context_.

Referenced by isc::dhcp::OptionDescriptor::OptionDescriptor(), isc::dhcp::CSVLeaseFile4::append(), isc::dhcp::CSVLeaseFile6::append(), contextToElement(), isc::dhcp::OptionDefinition::getContext(), isc::netconf::NetconfCfgMgr::getNetconfConfig(), isc::dhcp::OptionDescriptor::operator=(), isc::dhcp::Lease4::operator==(), isc::dhcp::Lease6::operator==(), isc::dhcp::Lease4::toText(), and isc::dhcp::Lease6::toText().

setContext()

void isc::data::UserContext::setContext ( const data::ConstElementPtr &  ctx )

inline

Sets user context.

Parameters

ctx	user context to be stored.

Definition at line 30 of file user_context.h.

References user_context_.

Referenced by isc::http::BasicHttpAuthClient::BasicHttpAuthClient(), isc::dhcp::OptionDescriptor::OptionDescriptor(), isc::dhcp::OptionDataParser::createOption(), isc::dhcp::OptionDescriptor::operator=(), isc::http::BasicHttpAuthConfig::parse(), and isc::dhcp::OptionDefinition::setContext().

toElement()

ElementPtr isc::data::UserContext::toElement ( data::ConstElementPtr  map )

static

Copy an Element map.

A previous version of this extracted comments.

Parameters

map	A pointer to map.

Returns

a copy of map

Definition at line 24 of file user_context.cc.

References isc::data::copy().

Referenced by isc::agent::CtrlAgentCfgContext::toElement(), isc::d2::D2CfgContext::toElement(), and isc::dhcp::SrvConfig::toElement().

Here is the call graph for this function:

Member Data Documentation

user_context_

data::ConstElementPtr isc::data::UserContext::user_context_

protected

Pointer to the user context (may be NULL)

Definition at line 52 of file user_context.h.

Referenced by getContext(), and setContext().

---

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

• user_context.h
• user_context.cc