Acl::CharacterSetOption Class Reference

option value to configure one or more characters (e.g., -m=",;") More...

#include <CharacterSetOption.h>

Inheritance diagram for Acl::CharacterSetOption:
Collaboration diagram for Acl::CharacterSetOption:

Public Types

typedef TypedOption
< CharacterSetOptionValue
Parent
 
enum  ValueExpectation {
  valueNone,
  valueOptional,
  valueRequired
}
 

Public Member Functions

 CharacterSetOption ()
 
void linkWith (CharacterSetOptionValue *recipient) const
 who to tell when this option is enabled More...
 
virtual bool configured () const override
 
virtual bool valued () const override
 
virtual void configureDefault () const override
 sets the default value when option is used without a value More...
 
virtual void configureWith (const SBuf &rawValue) const override
 sets the option value from rawValue More...
 
virtual void print (std::ostream &os) const override
 prints a configuration snippet (as an admin could have typed) More...
 

Public Attributes

ValueExpectation valueExpectation = valueNone
 expect "=value" part? More...
 

Detailed Description

Definition at line 40 of file CharacterSetOption.h.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
valueNone 
valueOptional 
valueRequired 

Definition at line 42 of file Options.h.

Constructor & Destructor Documentation

Acl::CharacterSetOption::CharacterSetOption ( )
inline

Definition at line 44 of file CharacterSetOption.h.

Member Function Documentation

virtual bool Acl::TypedOption< CharacterSetOptionValue >::configured ( ) const
inlineoverridevirtualinherited

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

Implements Acl::Option.

Definition at line 98 of file Options.h.

References Acl::TypedOption< Recipient >::recipient_.

virtual void Acl::TypedOption< CharacterSetOptionValue >::configureDefault ( ) const
inlineoverridevirtualinherited
virtual void Acl::TypedOption< CharacterSetOptionValue >::configureWith ( const SBuf rawValue) const
inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 112 of file Options.h.

References assert, and Acl::TypedOption< Recipient >::recipient_.

void Acl::TypedOption< CharacterSetOptionValue >::linkWith ( CharacterSetOptionValue recipient) const
inlineinherited

Definition at line 90 of file Options.h.

References assert, and Acl::TypedOption< Recipient >::recipient_.

virtual void Acl::TypedOption< CharacterSetOptionValue >::print ( std::ostream &  os) const
inlineoverridevirtualinherited
virtual bool Acl::TypedOption< CharacterSetOptionValue >::valued ( ) const
inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 99 of file Options.h.

References Acl::TypedOption< Recipient >::recipient_.

Member Data Documentation

ValueExpectation Acl::Option::valueExpectation = valueNone
inherited

Definition at line 61 of file Options.h.

Referenced by Acl::OptionsParser::parse().


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors