7#ifndef CALLOUT_HANDLE_H
8#define CALLOUT_HANDLE_H
14#include <boost/any.hpp>
15#include <boost/shared_ptr.hpp>
51class LibraryManagerCollection;
128 CalloutHandle(
const boost::shared_ptr<CalloutManager>& manager,
129 const boost::shared_ptr<LibraryManagerCollection>& lmcoll =
130 boost::shared_ptr<LibraryManagerCollection>());
145 template <
typename T>
147 arguments_[name] = value;
162 template <
typename T>
164 ElementCollection::const_iterator element_ptr = arguments_.find(name);
165 if (element_ptr == arguments_.end()) {
170 value = boost::any_cast<T>(element_ptr->second);
191 static_cast<void>(arguments_.erase(name));
251 template <
typename T>
253 getContextForLibrary()[name] = value;
269 template <
typename T>
273 ElementCollection::const_iterator element_ptr = lib_context.find(name);
274 if (element_ptr == lib_context.end()) {
276 "item " << name <<
" in the context associated with "
280 value = boost::any_cast<T>(element_ptr->second);
303 static_cast<void>(getContextForLibrary().erase(name));
313 getContextForLibrary().clear();
334 return (current_library_);
341 current_library_ = library_index;
348 return (current_hook_);
355 current_hook_ = hook_index;
369 int getLibraryIndex()
const;
401 boost::shared_ptr<LibraryManagerCollection> lm_collection_;
410 boost::shared_ptr<CalloutManager> manager_;
422 int current_library_;
This is a base class for exceptions thrown from the DNS library module.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
Per-packet callout handle.
void setCurrentLibrary(int library_index)
Set current library index.
void deleteContext(const std::string &name)
Delete context element.
void getContext(const std::string &name, T &value) const
Get context.
CalloutNextStep
Specifies allowed next steps.
@ NEXT_STEP_PARK
park the packet
@ NEXT_STEP_CONTINUE
continue normally
@ NEXT_STEP_DROP
drop the packet
@ NEXT_STEP_SKIP
skip the next processing step
ParkingLotHandlePtr getParkingLotHandlePtr() const
Returns pointer to the parking lot handle for this hook point.
void setContext(const std::string &name, T value)
Set context.
CalloutNextStep getStatus() const
Returns the next processing step.
std::string getHookName() const
Get hook name.
void deleteAllArguments()
Delete all arguments.
std::map< std::string, boost::any > ElementCollection
Typedef to allow abbreviation of iterator specification in methods.
void setStatus(const CalloutNextStep next)
Sets the next processing step.
~CalloutHandle()
Destructor.
void setCurrentHook(int hook_index)
Set current hook index.
void deleteArgument(const std::string &name)
Delete argument.
void getArgument(const std::string &name, T &value) const
Get argument.
void deleteAllContext()
Delete all context items.
int getCurrentHook() const
Get current hook index.
int getCurrentLibrary() const
Get current library index.
std::vector< std::string > getContextNames() const
Get context names.
void setArgument(const std::string &name, T value)
Set argument.
CalloutHandle(const boost::shared_ptr< CalloutManager > &manager, const boost::shared_ptr< LibraryManagerCollection > &lmcoll=boost::shared_ptr< LibraryManagerCollection >())
Constructor.
std::vector< std::string > getArgumentNames() const
Get argument names.
std::map< int, ElementCollection > ContextCollection
Typedef to allow abbreviations in specifications when accessing context.
NoSuchArgument(const char *file, size_t line, const char *what)
No such callout context item.
NoSuchCalloutContext(const char *file, size_t line, const char *what)
Wrapper class around callout handle which automatically resets handle's state.
ScopedCalloutHandleState(const CalloutHandlePtr &callout_handle)
Constructor.
~ScopedCalloutHandleState()
Destructor.
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
boost::shared_ptr< ParkingLotHandle > ParkingLotHandlePtr
Pointer to the parking lot handle.
boost::shared_ptr< CalloutHandle > CalloutHandlePtr
A shared pointer to a CalloutHandle object.
Defines the logger used by the top-level component of kea-lfc.