Search Toolkit Book for CHttpHeaders
#include <connect/ncbi_http_session.hpp>
Inheritance diagram for CHttpHeaders:
Collaboration diagram for CHttpHeaders:
Classes | |
| class | CHeaderNameConverter |
| Helper class allowing to use both strings and enums as header names. More... | |
Public Types | |
| enum | EHeaderName { eCacheControl = 0 , eContentLength , eContentType , eCookie , eDate , eExpires , eLocation , eRange , eReferer , eSetCookie , eUserAgent , eHost } |
| Some standard HTTP headers. More... | |
| typedef vector< string > | THeaderValues |
| List of header values (may be required for headers with multiple values like Cookie). More... | |
| typedef map< string, THeaderValues, PNocase > | THeaders |
| Map of header name-values, case-insensitive. More... | |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
Public Member Functions | |
| CHttpHeaders (void) | |
| Create empty headers list. More... | |
| bool | HasValue (CHeaderNameConverter name) const |
| Check if there's at least one header with the name. More... | |
| size_t | CountValues (CHeaderNameConverter name) const |
| Get number of values with the given name. More... | |
| const string & | GetValue (CHeaderNameConverter name) const |
| Get value of the header or empty string. More... | |
| const THeaderValues & | GetAllValues (CHeaderNameConverter name) const |
| Get all values with the given name. More... | |
| void | SetValue (CHeaderNameConverter name, CTempString value) |
| Remove all existing values with the name, set the new value. More... | |
| void | AddValue (CHeaderNameConverter name, CTempString value) |
| Add new value with the name (multiple values are allowed with the same name, the order is preserved). More... | |
| void | Clear (CHeaderNameConverter name) |
| Remove all values with the given name. More... | |
| void | ClearAll (void) |
| Remove all headers. More... | |
| void | Assign (const CHttpHeaders &headers) |
| Clear any existing values and copy all headers from 'headers' to this object. More... | |
| void | Merge (const CHttpHeaders &headers) |
| Add values from 'headers' to this object. More... | |
| virtual | ~CHttpHeaders (void) |
| void | ParseHttpHeader (const CTempString &headers) |
| Parse headers from the string (usually provided by a stream callback). More... | |
| string | GetHttpHeader (void) const |
| Get all headers as a single string as required by CConn_HttpStream. More... | |
| const THeaders & | Get () const |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
Static Public Member Functions | |
| static const char * | GetHeaderName (EHeaderName name) |
| Get string representation of the given name. More... | |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
Private Member Functions | |
| CHttpHeaders (const CHttpHeaders &) | |
| CHttpHeaders & | operator= (const CHttpHeaders &) |
| bool | x_IsReservedHeader (CTempString name) const |
Private Attributes | |
| THeaders | m_Headers |
Friends | |
| class | CHttpRequest |
| class | CHttpResponse |
Additional Inherited Members | |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
Definition at line 60 of file ncbi_http_session.hpp.
The documentation for this class was generated from the following files:
- include/connect/ncbi_http_session.hpp
- src/connect/ncbi_http_session.cpp
