Kea 2.6.0
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()

◆ getContext()

◆ setContext()

◆ toElement()

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

Copy an Element map.

A previous version of this extracted comments.

mapA pointer to map.
a copy of map

Definition at line 24 of file

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_

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: