#include <Notes.h>

Inheritance diagram for Note:
Collaboration diagram for Note:

Classes

class  Value
 Stores a value for the note. More...
 

Public Types

typedef RefCount< NotePointer
 
typedef std::vector< Value::PointerValues
 

Public Member Functions

 Note (const char *aKey, const size_t keyLen)
 
 Note (const SBuf aKey)
 
 Note (const Note &)=delete
 
Noteoperator= (const Note &)=delete
 
Value::Pointer addValue (const char *value, const bool quoted, const char *descr, const Value::Method m=Value::mhAppend)
 
bool match (HttpRequest *request, HttpReply *reply, const AccessLogEntryPointer &al, SBuf &matched)
 
const SBufkey () const
 
void updateNotePairs (NotePairsPointer pairs, const CharacterSet *delimiters, const AccessLogEntryPointer &al)
 
void dump (StoreEntry *entry, const char *key)
 Dump the single Note to the given StoreEntry object. More...
 
SBuf toString (const char *sep) const
 

Private Attributes

SBuf theKey
 The note key. More...
 
Values values
 The possible values list for the note. More...
 

Detailed Description

Used to store a note configuration. The notes are custom key:value pairs ICAP request headers or ECAP options used to pass custom transaction-state related meta information to squid internal subsystems or to adaptation services.

Definition at line 35 of file Notes.h.

Member Typedef Documentation

◆ Pointer

Definition at line 38 of file Notes.h.

◆ Values

Definition at line 73 of file Notes.h.

Constructor & Destructor Documentation

◆ Note() [1/3]

Note::Note ( const char *  aKey,
const size_t  keyLen 
)
inline

Definition at line 75 of file Notes.h.

◆ Note() [2/3]

Note::Note ( const SBuf  aKey)
inlineexplicit

◆ Note() [3/3]

Note::Note ( const Note )
delete

Member Function Documentation

◆ addValue()

Note::Value::Pointer Note::addValue ( const char *  value,
const bool  quoted,
const char *  descr,
const Value::Method  m = Value::mhAppend 
)

Adds a value to the note and returns a pointer to the related Value object.

Definition at line 62 of file Notes.cc.

References Note::Value::Value(), and values.

Referenced by Note().

◆ dump()

void Note::dump ( StoreEntry entry,
const char *  key 
)

Definition at line 107 of file Notes.cc.

References dump_acl_list(), key(), ConfigParser::QuoteString(), SBufToString(), storeAppendPrintf(), and values.

Referenced by key(), and Notes::~Notes().

◆ key()

const SBuf& Note::key ( ) const
inline

◆ match()

bool Note::match ( HttpRequest request,
HttpReply reply,
const AccessLogEntryPointer al,
SBuf matched 
)

Walks through the possible values list of the note, selects the first value, matching the given HttpRequest and HttpReply and assignes the given 'matched' to it.

Returns
true if matched, false otherwise

Definition at line 69 of file Notes.cc.

References ACLFilledChecklist::al, assert, SBuf::clear(), debugs, ACLChecklist::fastCheck(), HTTPMSGLOCK(), ACLFilledChecklist::reply, ACLFilledChecklist::syncAle(), theKey, and values.

Referenced by Note().

◆ operator=()

Note& Note::operator= ( const Note )
delete

◆ toString()

SBuf Note::toString ( const char *  sep) const

For the key and all its Values compile a string of "Key: Value" pairs separated by sep string.

Definition at line 118 of file Notes.cc.

References SBuf::appendf(), key(), SBuf::length(), and values.

Referenced by Notes::empty(), key(), and NotePairs::NotePairs().

◆ updateNotePairs()

void Note::updateNotePairs ( NotePairsPointer  pairs,
const CharacterSet delimiters,
const AccessLogEntryPointer al 
)

Member Data Documentation

◆ theKey

SBuf Note::theKey
private

Definition at line 99 of file Notes.h.

Referenced by key(), match(), and updateNotePairs().

◆ values

Values Note::values
private

Definition at line 100 of file Notes.h.

Referenced by addValue(), dump(), match(), NotePairs::NotePairs(), toString(), and updateNotePairs().


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors