Public Types | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
Acl::TypedOption< Recipient > Class Template Reference

a type-specific Option (e.g., a boolean –toggle or -m=SBuf) More...

#include <Options.h>

Inheritance diagram for Acl::TypedOption< Recipient >:
Inheritance graph
[legend]
Collaboration diagram for Acl::TypedOption< Recipient >:
Collaboration graph
[legend]

Public Types

enum  ValueExpectation {
  valueNone,
  valueOptional,
  valueRequired
}
 

Public Member Functions

 TypedOption (const char *nameThatEnables, const char *nameThatDisables=nullptr, ValueExpectation vex=valueNone)
 
void linkWith (Recipient *recipient) const
 who to tell when this option is enabled More...
 
bool configured () const override
 
bool disabled () const override
 whether disable() has been called More...
 
bool valued () const override
 
void unconfigure () const override
 clear enable(), configureWith(), or disable() effects More...
 
void enable () const override
 called after parsing onName without a value (e.g., -x or –enable-x) More...
 
void configureWith (const SBuf &rawValue) const override
 called after parsing onName and a value (e.g., -x=v or –enable-x=v) More...
 
void disable () const override
 called after parsing offName (e.g., +i or –disable-x) More...
 
void print (std::ostream &os) const override
 prints a configuration snippet (as an admin could have typed) More...
 

Public Attributes

const char *const onName = nullptr
 A name that must be used to explicitly enable this Option (required). More...
 
const char *const offName = nullptr
 
ValueExpectation valueExpectation = valueNone
 expect "=value" part? More...
 

Private Member Functions

void import (const SBuf &rawValue) const
 
void printValue (std::ostream &os) const
 
void import (const SBuf &rawValue) const
 
void printValue (std::ostream &os) const
 

Private Attributes

Recipient * recipient_ = nullptr
 parsing results storage More...
 

Detailed Description

template<class Recipient>
class Acl::TypedOption< Recipient >

Definition at line 129 of file Options.h.

Member Enumeration Documentation

◆ ValueExpectation

enum Acl::Option::ValueExpectation
inherited
Enumerator
valueNone 
valueOptional 
valueRequired 

Definition at line 59 of file Options.h.

Constructor & Destructor Documentation

◆ TypedOption()

template<class Recipient >
Acl::TypedOption< Recipient >::TypedOption ( const char *  nameThatEnables,
const char *  nameThatDisables = nullptr,
ValueExpectation  vex = valueNone 
)
inlineexplicit

Definition at line 133 of file Options.h.

Member Function Documentation

◆ configured()

template<class Recipient >
bool Acl::TypedOption< Recipient >::configured ( ) const
inlineoverridevirtual

whether the admin explicitly specified this option (i.e., whether enable(), configureWith(), or disable() has been called)

Implements Acl::Option.

Definition at line 145 of file Options.h.

Referenced by Acl::TypedOption< CharacterSetOptionValue >::print().

◆ configureWith()

template<class Recipient >
void Acl::TypedOption< Recipient >::configureWith ( const SBuf &  rawValue) const
inlineoverridevirtual

Implements Acl::Option.

Definition at line 163 of file Options.h.

◆ disable()

template<class Recipient >
void Acl::TypedOption< Recipient >::disable ( ) const
inlineoverridevirtual

Implements Acl::Option.

Definition at line 172 of file Options.h.

◆ disabled()

template<class Recipient >
bool Acl::TypedOption< Recipient >::disabled ( ) const
inlineoverridevirtual

Implements Acl::Option.

Definition at line 146 of file Options.h.

Referenced by Acl::TypedOption< CharacterSetOptionValue >::print().

◆ enable()

template<class Recipient >
void Acl::TypedOption< Recipient >::enable ( ) const
inlineoverridevirtual

Implements Acl::Option.

Definition at line 154 of file Options.h.

◆ import() [1/2]

void Acl::TypedOption< CharacterSetOptionValue >::import ( const SBuf &  rawValue) const
inlineprivate

Definition at line 25 of file CharacterSetOption.h.

◆ import() [2/2]

void Acl::BooleanOption::import ( const SBuf &  rawValue) const
inlineprivate

Definition at line 194 of file Options.h.

◆ linkWith()

template<class Recipient >
void Acl::TypedOption< Recipient >::linkWith ( Recipient *  recipient) const
inline

Definition at line 137 of file Options.h.

Referenced by ACLDestinationIP::options(), ACLMaxUserIP::options(), Acl::AnnotationCheck::options(), Acl::DestinationDomainCheck::options(), and Acl::ServerNameCheck::options().

◆ print()

template<class Recipient >
void Acl::TypedOption< Recipient >::print ( std::ostream &  os) const
inlineoverridevirtual

Implements Acl::Option.

Definition at line 181 of file Options.h.

◆ printValue() [1/2]

void Acl::TypedOption< CharacterSetOptionValue >::printValue ( std::ostream &  os) const
inlineprivate

Definition at line 33 of file CharacterSetOption.h.

◆ printValue() [2/2]

template<class Recipient >
void Acl::TypedOption< Recipient >::printValue ( std::ostream &  os) const
inlineprivate

Definition at line 195 of file Options.h.

Referenced by Acl::TypedOption< CharacterSetOptionValue >::print().

◆ unconfigure()

template<class Recipient >
void Acl::TypedOption< Recipient >::unconfigure ( ) const
inlineoverridevirtual

Implements Acl::Option.

Definition at line 149 of file Options.h.

◆ valued()

template<class Recipient >
bool Acl::TypedOption< Recipient >::valued ( ) const
inlineoverridevirtual

Implements Acl::Option.

Definition at line 147 of file Options.h.

Referenced by Acl::TypedOption< CharacterSetOptionValue >::print().

Member Data Documentation

◆ offName

const char* const Acl::Option::offName = nullptr
inherited

A name that must be used to explicitly disable this Option (optional). Nil for (and only for) options that cannot be disabled().

Definition at line 92 of file Options.h.

Referenced by Acl::TypedOption< CharacterSetOptionValue >::disabled(), and Acl::TypedOption< CharacterSetOptionValue >::print().

◆ onName

const char* const Acl::Option::onName = nullptr
inherited

Definition at line 88 of file Options.h.

Referenced by Acl::Option::Option(), and Acl::TypedOption< CharacterSetOptionValue >::print().

◆ recipient_

template<class Recipient >
Recipient* Acl::TypedOption< Recipient >::recipient_ = nullptr
mutableprivate

Definition at line 199 of file Options.h.

Referenced by Acl::TypedOption< CharacterSetOptionValue >::configured(), Acl::TypedOption< CharacterSetOptionValue >::configureWith(), Acl::TypedOption< CharacterSetOptionValue >::disable(), Acl::TypedOption< CharacterSetOptionValue >::disabled(), Acl::TypedOption< CharacterSetOptionValue >::enable(), Acl::TypedOption< CharacterSetOptionValue >::import(), Acl::TypedOption< CharacterSetOptionValue >::linkWith(), Acl::TypedOption< CharacterSetOptionValue >::printValue(), Acl::TypedOption< CharacterSetOptionValue >::unconfigure(), and Acl::TypedOption< CharacterSetOptionValue >::valued().

◆ valueExpectation

ValueExpectation Acl::Option::valueExpectation = valueNone
inherited

Definition at line 94 of file Options.h.

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

 

Introduction

Documentation

Support

Miscellaneous