Search Toolkit Book for CTMgr_ClientInfo
#include <objects/trackmgr/TMgr_ClientInfo.hpp>
Inheritance diagram for CTMgr_ClientInfo:
Collaboration diagram for CTMgr_ClientInfo:
Public Member Functions | |
| CTMgr_ClientInfo (void) | |
| ~CTMgr_ClientInfo (void) | |
| virtual void | SetContext (const TContext &value) |
| virtual TContext & | SetContext (void) |
| void | SetContextAttr (const string &key, const string &value) |
| const string & | GetContextAttr (const string &key) const |
| Public Member Functions inherited from CTMgr_ClientInfo_Base | |
| CTMgr_ClientInfo_Base (void) | |
| virtual | ~CTMgr_ClientInfo_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetClient_name (void) const |
| Check if a value has been assigned to Client_name data member. More... | |
| bool | CanGetClient_name (void) const |
| Check if it is safe to call GetClient_name method. More... | |
| void | ResetClient_name (void) |
| Reset Client_name data member. More... | |
| const TClient_name & | GetClient_name (void) const |
| Get the Client_name member data. More... | |
| void | SetClient_name (const TClient_name &value) |
| Assign a value to Client_name data member. More... | |
| void | SetClient_name (TClient_name &&value) |
| TClient_name & | SetClient_name (void) |
| Assign a value to Client_name data member. More... | |
| bool | IsSetContext (void) const |
| Check if a value has been assigned to Context data member. More... | |
| bool | CanGetContext (void) const |
| Check if it is safe to call GetContext method. More... | |
| void | ResetContext (void) |
| Reset Context data member. More... | |
| const TContext & | GetContext (void) const |
| Get the Context member data. More... | |
| void | SetContext (const TContext &value) |
| Assign a value to Context data member. More... | |
| void | SetContext (TContext &&value) |
| TContext & | SetContext (void) |
| Assign a value to Context data member. More... | |
| bool | IsSetInhouse (void) const |
| Check if a value has been assigned to Inhouse data member. More... | |
| bool | CanGetInhouse (void) const |
| Check if it is safe to call GetInhouse method. More... | |
| void | ResetInhouse (void) |
| Reset Inhouse data member. More... | |
| void | SetDefaultInhouse (void) |
| Assign default value to Inhouse data member. More... | |
| TInhouse | GetInhouse (void) const |
| Get the Inhouse member data. More... | |
| void | SetInhouse (TInhouse value) |
| Assign a value to Inhouse data member. More... | |
| TInhouse & | SetInhouse (void) |
| Assign a value to Inhouse data member. More... | |
| bool | IsSetContext_attrs (void) const |
| permission keys etc Check if a value has been assigned to Context_attrs data member. More... | |
| bool | CanGetContext_attrs (void) const |
| Check if it is safe to call GetContext_attrs method. More... | |
| void | ResetContext_attrs (void) |
| Reset Context_attrs data member. More... | |
| const TContext_attrs & | GetContext_attrs (void) const |
| Get the Context_attrs member data. More... | |
| TContext_attrs & | SetContext_attrs (void) |
| Assign a value to Context_attrs data member. More... | |
| virtual void | Reset (void) |
| Reset the whole object. More... | |
| Public Member Functions inherited from CSerialObject | |
| CSerialObject (void) | |
| virtual | ~CSerialObject (void) |
| virtual const CTypeInfo * | GetThisTypeInfo (void) const =0 |
| virtual void | Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive) |
| Set object to copy of another one. More... | |
| virtual bool | Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const |
| Check if both objects contain the same values. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| void | ThrowUnassigned (TMemberIndex index) const |
| void | ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const |
| bool | HasNamespaceName (void) const |
| Check if object data type has namespace name. More... | |
| const string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (void) const |
| Get namespace prefix. 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... | |
| 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 | |
| typedef CTMgr_ClientInfo_Base | Tparent |
Private Member Functions | |
| CTMgr_ClientInfo (const CTMgr_ClientInfo &value) | |
| CTMgr_ClientInfo & | operator= (const CTMgr_ClientInfo &value) |
Additional Inherited Members | |
| Public Types inherited from CTMgr_ClientInfo_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_client_name , e_context , e_inhouse , e_context_attrs } |
| typedef string | TClient_name |
| typedef string | TContext |
| typedef bool | TInhouse |
| typedef list< CRef< CTMgr_AttrSpec > > | TContext_attrs |
| typedef Tparent::CMemberIndex< E_memberIndex, 5 > | TmemberIndex |
| 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... | |
| Static Public Member Functions inherited from CSerialObject | |
| static void | SetVerifyDataThread (ESerialVerifyData verify) |
| static void | SetVerifyDataGlobal (ESerialVerifyData verify) |
| static string | UnassignedString (void) |
| static CStringUTF8 | UnassignedStringUTF8 (void) |
| static char | UnassignedByte (void) |
| 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 CSerialObject | |
| static const char * | ms_UnassignedStr = "<*unassigned*>" |
| static const char | ms_UnassignedByte = char(0xcd) |
| 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 53 of file TMgr_ClientInfo.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 55 of file TMgr_ClientInfo.hpp.
Constructor & Destructor Documentation
◆ CTMgr_ClientInfo() [1/2]
|
inline |
Definition at line 81 of file TMgr_ClientInfo.hpp.
◆ ~CTMgr_ClientInfo()
| CTMgr_ClientInfo::~CTMgr_ClientInfo | ( | void | ) |
Definition at line 54 of file TMgr_ClientInfo.cpp.
◆ CTMgr_ClientInfo() [2/2]
|
private |
Member Function Documentation
◆ GetContextAttr()
Definition at line 98 of file TMgr_ClientInfo.cpp.
References NStr::Equal(), CTMgr_ClientInfo_Base::GetContext_attrs(), CTMgr_ClientInfo_Base::IsSetContext_attrs(), kEmptyStr, and ncbi::grid::netcache::search::fields::key.
◆ operator=()
|
private |
◆ SetContext() [1/2]
Definition at line 58 of file TMgr_ClientInfo.cpp.
References context, NStr::fSplit_ByPattern, ITERATE, ncbi::grid::netcache::search::fields::key, CTMgr_ClientInfo_Base::SetContext(), CTMgr_ClientInfo_Base::SetContext_attrs(), NStr::Split(), NStr::SplitInTwo(), val, and rapidjson::value.
Referenced by CTMgr_DisplayTrackRequest::SetResourceName().
◆ SetContext() [2/2]
|
inlinevirtual |
Definition at line 63 of file TMgr_ClientInfo.hpp.
References CTMgr_ClientInfo_Base::SetContext().
◆ SetContextAttr()
Definition at line 90 of file TMgr_ClientInfo.cpp.
References ncbi::grid::netcache::search::fields::key, CTMgr_ClientInfo_Base::SetContext_attrs(), and rapidjson::value.
The documentation for this class was generated from the following files:
- include/objects/trackmgr/TMgr_ClientInfo.hpp
- src/objects/trackmgr/TMgr_ClientInfo.cpp
