Kea: nc_remove.h Source File

| Kea 3.0.0

nc_remove.h
Go to the documentation of this file.
1// Copyright (C) 2013-2024 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#ifndef NC_REMOVE_H
8#define NC_REMOVE_H
9
11
12#include <d2srv/nc_trans.h>
13
14namespace isc {
15namespace d2 {
16
18 class NameRemoveTransactionError : public isc::Exception {
19public:
20 NameRemoveTransactionError(const char* file, size_t line,
21 const char* what) :
22 isc::Exception(file, line, what) { }
23};
24
51 class NameRemoveTransaction : public NameChangeTransaction {
52public:
53
55
56 static const int REMOVING_FWD_ADDRS_ST = NCT_DERIVED_STATE_MIN + 1;
57
59 static const int REMOVING_FWD_RRS_ST = NCT_DERIVED_STATE_MIN + 2;
60
62 static const int REMOVING_REV_PTRS_ST = NCT_DERIVED_STATE_MIN + 3;
64
66
68
69
82 NameRemoveTransaction(asiolink::IOServicePtr& io_service,
83 dhcp_ddns::NameChangeRequestPtr& ncr,
84 DdnsDomainPtr& forward_domain,
85 DdnsDomainPtr& reverse_domain,
86 D2CfgMgrPtr& cfg_mgr);
87
89 virtual ~NameRemoveTransaction();
90
91protected:
98 virtual void defineEvents();
99
107 virtual void verifyEvents();
108
115 virtual void defineStates();
116
124 virtual void verifyStates();
125
146 void readyHandler();
147
169 void selectingFwdServerHandler();
170
193 void selectingRevServerHandler();
194
236 void removingFwdAddrsHandler();
237
288 void removingFwdRRsHandler();
289
330 void removingRevPtrsHandler();
331
346 void processRemoveOkHandler();
347
366 void processRemoveFailedHandler();
367
383 void buildRemoveFwdAddressRequest();
384
403 void buildRemoveFwdRRsRequest();
404
420 void buildRemoveRevPtrsRequest();
421};
422
424 typedef boost::shared_ptr<NameRemoveTransaction> NameRemoveTransactionPtr;
425
426
427} // namespace isc::d2
428} // namespace isc
429#endif
isc::Exception
This is a base class for exceptions thrown from the DNS library module.
Definition exceptions/exceptions.h:23
isc::Exception::Exception
Exception(const char *file, size_t line, const char *what)
Constructor for a given type for exceptions with file name and file line number.
Definition exceptions/exceptions.cc:17
isc::Exception::what
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
Definition exceptions/exceptions.cc:32
isc::d2::NameChangeTransaction::NameChangeTransaction
NameChangeTransaction(asiolink::IOServicePtr &io_service, dhcp_ddns::NameChangeRequestPtr &ncr, DdnsDomainPtr &forward_domain, DdnsDomainPtr &reverse_domain, D2CfgMgrPtr &cfg_mgr)
Constructor.
Definition nc_trans.cc:69
isc::d2::NameChangeTransaction::NCT_DERIVED_STATE_MIN
static const int NCT_DERIVED_STATE_MIN
Value at which custom states in a derived class should begin.
Definition nc_trans.h:108
isc::d2::NameRemoveTransactionError::NameRemoveTransactionError
NameRemoveTransactionError(const char *file, size_t line, const char *what)
Definition nc_remove.h:20
isc::d2::NameRemoveTransaction::verifyStates
virtual void verifyStates()
Validates the contents of the set of states.
Definition nc_remove.cc:111
isc::d2::NameRemoveTransaction::defineEvents
virtual void defineEvents()
Adds events defined by NameRemoveTransaction to the event set.
Definition nc_remove.cc:45
isc::d2::NameRemoveTransaction::processRemoveOkHandler
void processRemoveOkHandler()
State handler for PROCESS_TRANS_OK_ST.
Definition nc_remove.cc:578
isc::d2::NameRemoveTransaction::readyHandler
void readyHandler()
State handler for READY_ST.
Definition nc_remove.cc:128
isc::d2::NameRemoveTransaction::buildRemoveRevPtrsRequest
void buildRemoveRevPtrsRequest()
Builds a DNS request to remove a reverse DNS entry for a FQDN.
Definition nc_remove.cc:694
isc::d2::NameRemoveTransaction::verifyEvents
virtual void verifyEvents()
Validates the contents of the set of events.
Definition nc_remove.cc:55
isc::d2::NameRemoveTransaction::selectingRevServerHandler
void selectingRevServerHandler()
State handler for SELECTING_REV_SERVER_ST.
Definition nc_remove.cc:427
isc::d2::NameRemoveTransaction::removingFwdAddrsHandler
void removingFwdAddrsHandler()
State handler for REMOVING_FWD_ADDRS_ST.
Definition nc_remove.cc:176
isc::d2::NameRemoveTransaction::REMOVING_REV_PTRS_ST
static const int REMOVING_REV_PTRS_ST
State that attempts to remove reverse PTR records.
Definition nc_remove.h:62
isc::d2::NameRemoveTransaction::defineStates
virtual void defineStates()
Adds states defined by NameRemoveTransaction to the state set.
Definition nc_remove.cc:73
isc::d2::NameRemoveTransaction::removingRevPtrsHandler
void removingRevPtrsHandler()
State handler for REMOVING_REV_PTRS_ST.
Definition nc_remove.cc:456
isc::d2::NameRemoveTransaction::NameRemoveTransaction
NameRemoveTransaction(asiolink::IOServicePtr &io_service, dhcp_ddns::NameChangeRequestPtr &ncr, DdnsDomainPtr &forward_domain, DdnsDomainPtr &reverse_domain, D2CfgMgrPtr &cfg_mgr)
Event sent when replace attempt to fails with address not in use.
Definition nc_remove.cc:28
isc::d2::NameRemoveTransaction::removingFwdRRsHandler
void removingFwdRRsHandler()
State handler for REMOVING_FWD_RRS_ST.
Definition nc_remove.cc:291
isc::d2::NameRemoveTransaction::REMOVING_FWD_RRS_ST
static const int REMOVING_FWD_RRS_ST
State that attempts to remove any other forward RRs for the DHCID.
Definition nc_remove.h:59
isc::d2::NameRemoveTransaction::selectingFwdServerHandler
void selectingFwdServerHandler()
State handler for SELECTING_FWD_SERVER_ST.
Definition nc_remove.cc:148
isc::d2::NameRemoveTransaction::buildRemoveFwdAddressRequest
void buildRemoveFwdAddressRequest()
Builds a DNS request to remove a forward DNS address for a FQDN.
Definition nc_remove.cc:614
isc::d2::NameRemoveTransaction::buildRemoveFwdRRsRequest
void buildRemoveFwdRRsRequest()
Builds a DNS request to remove all forward DNS RRs for a FQDN.
Definition nc_remove.cc:646
isc::d2::NameRemoveTransaction::~NameRemoveTransaction
virtual ~NameRemoveTransaction()
Destructor.
Definition nc_remove.cc:41
isc::d2::NameRemoveTransaction::processRemoveFailedHandler
void processRemoveFailedHandler()
State handler for PROCESS_TRANS_FAILED_ST.
Definition nc_remove.cc:595
isc::d2::NameRemoveTransaction::REMOVING_FWD_ADDRS_ST
static const int REMOVING_FWD_ADDRS_ST
State that attempts to remove specific forward address record.
Definition nc_remove.h:56
isc::asiolink::IOServicePtr
boost::shared_ptr< IOService > IOServicePtr
Defines a smart pointer to an IOService instance.
Definition io_service.h:28
isc::d2
Definition check_exists_add.cc:19
isc::d2::DdnsDomainPtr
boost::shared_ptr< DdnsDomain > DdnsDomainPtr
Defines a pointer for DdnsDomain instances.
Definition d2_config.h:624
isc::d2::D2CfgMgrPtr
boost::shared_ptr< D2CfgMgr > D2CfgMgrPtr
Defines a shared pointer to D2CfgMgr.
Definition d2_cfg_mgr.h:367
isc::d2::NameRemoveTransactionPtr
boost::shared_ptr< NameRemoveTransaction > NameRemoveTransactionPtr
Defines a pointer to a NameRemoveTransaction.
Definition nc_remove.h:424
isc::dhcp_ddns::NameChangeRequestPtr
boost::shared_ptr< NameChangeRequest > NameChangeRequestPtr
Defines a pointer to a NameChangeRequest.
Definition ncr_msg.h:241
isc::util::file
Definition filesystem.cc:28
isc
Defines the logger used by the top-level component of kea-lfc.
Definition agent_parser.cc:148
nc_trans.h
This file defines the class NameChangeTransaction.