Search Toolkit Book for CRetryContext
CRetryContext – Retry context. More...
#include <util/retry_ctx.hpp>
Inheritance diagram for CRetryContext:
Collaboration diagram for CRetryContext:
Public Types | |
| enum | EContentOverride { eNot_set , eNoContent , eFromResponse , eData } |
| Content override flags. More... | |
| typedef map< string, string > | TValues |
| Map of name-value pairs. 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 | |
| CRetryContext (void) | |
| virtual | ~CRetryContext (void) |
| bool | GetNeedRetry (void) const |
| Check if another retry attempt has been requested (any new headers except STOP received in the last reply). More... | |
| void | SetNeedRetry (void) |
| void | ResetNeedRetry (void) |
| void | Reset (void) |
| Clear all options. More... | |
| bool | IsSetStop (void) const |
| Check if STOP flag is set. More... | |
| const string & | GetStopReason (void) const |
| Get STOP reason (or empty string). More... | |
| void | SetStop (const string &reason) |
| Set STOP flag, clear all other options. More... | |
| void | ResetStop (void) |
| Reset STOP flag and reason. More... | |
| bool | IsSetDelay (void) const |
| Check if retry delay is set. More... | |
| const CTimeSpan & | GetDelay (void) const |
| Get retry delay. More... | |
| void | SetDelay (CTimeSpan delay) |
| Set retry delay. More... | |
| void | SetDelay (double sec) |
| Set retry delay in seconds. More... | |
| void | ResetDelay (void) |
| Reset delay. More... | |
| bool | IsSetArgs (void) const |
| Check if retry args are set. More... | |
| const string & | GetArgs (void) const |
| Get retry args, URL-decoded. More... | |
| void | SetArgs (const string &args) |
| Set retry args. More... | |
| void | SetArgs (const CUrlArgs &args) |
| Set retry args. More... | |
| void | ResetArgs (void) |
| Reset args. More... | |
| bool | IsSetUrl (void) const |
| Check if retry URL is set. More... | |
| const string & | GetUrl (void) const |
| Get retry URL. More... | |
| void | SetUrl (const string &url) |
| Set retry URL. More... | |
| void | SetUrl (const CUrl &url) |
| Set retry URL. More... | |
| void | ResetUrl (void) |
| Reset URL. More... | |
| bool | IsSetContentOverride (void) const |
| Check if content source is set. More... | |
| EContentOverride | GetContentOverride (void) const |
| Get content source. More... | |
| void | SetContentOverride (EContentOverride content) |
| Set content source. More... | |
| void | ResetContentOverride (void) |
| Reset content source. More... | |
| bool | IsSetContent (void) const |
| Check if retry content is set and content-override flag assumes any content (eFromResponse or eData). More... | |
| const string & | GetContent (void) const |
| Get retry content. More... | |
| void | SetContent (const string &content) |
| Set retry content. More... | |
| void | ResetContent (void) |
| Reset content. More... | |
| bool | NeedReconnect (void) const |
| Check if the client should reconnect (e.g. if URL or args have changed). More... | |
| void | SetNeedReconnect (void) |
| Set need-reconnect flag. More... | |
| void | ResetNeedReconnect (void) |
| Reset need-reconnect flag (e.g. More... | |
| virtual void | GetValues (TValues &) const |
| Fill name-value pairs (e.g. More... | |
| 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 |
Private Types | |
| enum | FFlags { fStop = 1 << 0 , fDelay = 1 << 1 , fArgs = 1 << 2 , fUrl = 1 << 3 , fContentOverride = 1 << 4 , fContent = 1 << 5 } |
| typedef int | TFlags |
Private Member Functions | |
| bool | x_IsSetFlag (FFlags f) const |
| void | x_SetFlag (FFlags f, bool value=true) |
Private Attributes | |
| TFlags | m_Flags |
| string | m_StopReason |
| CTimeSpan | m_Delay |
| string | m_Args |
| string | m_Url |
| EContentOverride | m_ContentOverride |
| string | m_Content |
| bool | m_NeedRetry |
| bool | m_NeedReconnect |
Additional Inherited Members | |
| 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) |
| 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
CRetryContext – Retry context.
The class used to store, send and receive retry related data.
Definition at line 57 of file retry_ctx.hpp.
The documentation for this class was generated from the following file:
- include/util/retry_ctx.hpp
