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 (const char *name)
void	linkWith (CharacterSetOptionValue *recipient) const
	who to tell when this option is enabled
bool	configured () const override
bool	disabled () const override
	whether disable() has been called
bool	valued () const override
void	unconfigure () const override
	clear enable(), configureWith(), or disable() effects
void	enable () const override
	called after parsing onName without a value (e.g., -x or –enable-x)
void	configureWith (const SBuf &rawValue) const override
	called after parsing onName and a value (e.g., -x=v or –enable-x=v)
void	disable () const override
	called after parsing offName (e.g., +i or –disable-x)
void	print (std::ostream &os) const override
	prints a configuration snippet (as an admin could have typed)

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

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

Private Attributes
CharacterSetOptionValue *	recipient_
	parsing results storage

Detailed Description

Definition at line 39 of file CharacterSetOption.h.

Member Typedef Documentation

Parent

typedef TypedOption<CharacterSetOptionValue> Acl::CharacterSetOption::Parent

Definition at line 42 of file CharacterSetOption.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

CharacterSetOption()

Acl::CharacterSetOption::CharacterSetOption ( const char *  name )

inlineexplicit

Definition at line 43 of file CharacterSetOption.h.

Member Function Documentation

configured()

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

inlineoverridevirtualinherited

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.

configureWith()

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

inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 163 of file Options.h.

disable()

void Acl::TypedOption< CharacterSetOptionValue >::disable ( ) const

inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 172 of file Options.h.

disabled()

bool Acl::TypedOption< CharacterSetOptionValue >::disabled ( ) const

inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 146 of file Options.h.

enable()

void Acl::TypedOption< CharacterSetOptionValue >::enable ( ) const

inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 154 of file Options.h.

import() [1/2]

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

inlineprivateinherited

Definition at line 25 of file CharacterSetOption.h.

import() [2/2]

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

inlineprivateinherited

Definition at line 194 of file Options.h.

linkWith()

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

inlineinherited

Definition at line 137 of file Options.h.

print()

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

inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 181 of file Options.h.

printValue() [1/2]

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

inlineprivateinherited

Definition at line 33 of file CharacterSetOption.h.

printValue() [2/2]

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

inlineprivateinherited

Definition at line 195 of file Options.h.

unconfigure()

void Acl::TypedOption< CharacterSetOptionValue >::unconfigure ( ) const

inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 149 of file Options.h.

valued()

bool Acl::TypedOption< CharacterSetOptionValue >::valued ( ) const

inlineoverridevirtualinherited

Implements Acl::Option.

Definition at line 147 of file Options.h.

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< Recipient >::disabled(), and Acl::TypedOption< Recipient >::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< Recipient >::print().

recipient_

CharacterSetOptionValue * Acl::TypedOption< CharacterSetOptionValue >::recipient_

mutableprivateinherited

Definition at line 199 of file Options.h.

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:

• squid/src/acl/CharacterSetOption.h