Kea 3.0.0
isc::host_cmds::HostCmdsImpl::Parameters Class Reference

Parameters specified for reservation-get and reservation-del. More...

Public Member Functions

 Parameters ()
 Default constructor.

Public Attributes

IOAddress addr
 Specifies IPv4 or IPv6 address (used when query_by_addr is true)
bool has_subnet_id
 Specifies if subnet-id is present.
uint64_t host_id
 Specifies host identifier (default 0).
std::string hostname
 Specifies host name (default "").
std::vector< uint8_t > ident
 Specifies identifier value (used when query_by_addr is false)
HostMgrOperationTarget operation_target
 Specifies the target host source (default UNSPECIFIED_SOURCE which means the default host source is command-related).
size_t page_limit
 Specifies page limit (no default).
bool query_by_addr
 Specifies parameter types (true = query by address, false = query by identifier-type,identifier)
size_t source_index
 Specifies source index (default 0).
SubnetID subnet_id
 Specifies subnet-id.
Host::IdentifierType type
 Specifies identifier type (usually FLEX_ID, used when query_by_addr is false)

Detailed Description

Parameters specified for reservation-get and reservation-del.

As both call types (get and delete) need specify which reservation to act on, they have the same set of parameters. In particular, those two call types support the following sets of parameters:

  • subnet-id, address
  • subnet-id, identifier type, identifier value

This class stores those parameters and is used to pass them around.

Definition at line 60 of file host_cmds.cc.

Constructor & Destructor Documentation

◆ Parameters()

isc::host_cmds::HostCmdsImpl::Parameters::Parameters ( )
inline

Member Data Documentation

◆ addr

IOAddress isc::host_cmds::HostCmdsImpl::Parameters::addr

◆ has_subnet_id

bool isc::host_cmds::HostCmdsImpl::Parameters::has_subnet_id

◆ host_id

uint64_t isc::host_cmds::HostCmdsImpl::Parameters::host_id

Specifies host identifier (default 0).

Definition at line 90 of file host_cmds.cc.

Referenced by Parameters(), and isc::host_cmds::HostCmdsImpl::reservationGetPageHandler().

◆ hostname

std::string isc::host_cmds::HostCmdsImpl::Parameters::hostname

Specifies host name (default "").

Definition at line 93 of file host_cmds.cc.

Referenced by isc::host_cmds::HostCmdsImpl::reservationGetByHostnameHandler().

◆ ident

std::vector<uint8_t> isc::host_cmds::HostCmdsImpl::Parameters::ident

◆ operation_target

◆ page_limit

size_t isc::host_cmds::HostCmdsImpl::Parameters::page_limit

Specifies page limit (no default).

Definition at line 84 of file host_cmds.cc.

Referenced by Parameters(), and isc::host_cmds::HostCmdsImpl::reservationGetPageHandler().

◆ query_by_addr

bool isc::host_cmds::HostCmdsImpl::Parameters::query_by_addr

Specifies parameter types (true = query by address, false = query by identifier-type,identifier)

Definition at line 81 of file host_cmds.cc.

Referenced by Parameters(), isc::host_cmds::HostCmdsImpl::reservationDelHandler(), and isc::host_cmds::HostCmdsImpl::reservationGetHandler().

◆ source_index

size_t isc::host_cmds::HostCmdsImpl::Parameters::source_index

Specifies source index (default 0).

Definition at line 87 of file host_cmds.cc.

Referenced by Parameters(), and isc::host_cmds::HostCmdsImpl::reservationGetPageHandler().

◆ subnet_id

◆ type

Host::IdentifierType isc::host_cmds::HostCmdsImpl::Parameters::type

Specifies identifier type (usually FLEX_ID, used when query_by_addr is false)

Definition at line 74 of file host_cmds.cc.

Referenced by Parameters(), isc::host_cmds::HostCmdsImpl::reservationDelHandler(), isc::host_cmds::HostCmdsImpl::reservationGetByIdHandler(), and isc::host_cmds::HostCmdsImpl::reservationGetHandler().


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