Client for ASN.1-based protocol defined in file id1.asn

#include <objects/id1/id1_client.hpp>

Inheritance diagram for CID1Client:

Collaboration diagram for CID1Client:

Public Member Functions
	CID1Client (void)

	~CID1Client (void)

void	Ask (const TRequest &request, TReply &reply, TReplyChoice::E_Choice wanted)

void	Ask (const TRequest &request, TReply &reply)

void	SetAllowDeadEntries (bool ok)

bool	GetAllowDeadEntries (void)

virtual CRef< CSeq_entry >	AskGetsefromgi (const CID1server_maxcomplex &req, TReply *reply=0)

CRef< CSeq_entry >	FetchEntry (TGi gi, int max_complexity=0)

CRef< CSeq_entry >	FetchEntry (const CSeq_id &id, int max_complexity=0)

CRef< CSeq_entry >	FetchEntry (const string &id_string, int max_complexity=0)

Public Member Functions inherited from CID1Client_Base
	CID1Client_Base (void)

virtual	~CID1Client_Base (void)

virtual void	AskInit (TReply *reply=0)

virtual NCBI_NS_NCBI::TGi	AskGetgi (const CSeq_id &req, TReply *reply=0)

virtual void	AskFini (TReply *reply=0)

virtual list< CRef< CSeq_id > >	AskGetseqidsfromgi (const NCBI_NS_NCBI::TGi &req, TReply *reply=0)

virtual list< CRef< CID1Seq_hist > >	AskGetgihist (const NCBI_NS_NCBI::TGi &req, TReply *reply=0)

virtual list< CRef< CID1Seq_hist > >	AskGetgirev (const NCBI_NS_NCBI::TGi &req, TReply *reply=0)

virtual int	AskGetgistate (const NCBI_NS_NCBI::TGi &req, TReply *reply=0)

virtual CRef< CID1SeqEntry_info >	AskGetsewithinfo (const CID1server_maxcomplex &req, TReply *reply=0)

virtual CRef< CID1blob_info >	AskGetblobinfo (const CID1server_maxcomplex &req, TReply *reply=0)

Public Member Functions inherited from CRPCClient< CID1server_request, CID1server_back >
	CRPCClient (const string &service=kEmptyStr)

	CRPCClient (const string &service, ESerialDataFormat format)

	CRPCClient (const string &service, ESerialDataFormat format, unsigned int try_limit)

virtual	~CRPCClient (void)

virtual void	WriteRequest (CObjectOStream &out, const CID1server_request &request)

virtual void	ReadReply (CObjectIStream &in, CID1server_back &reply)

EIO_Status	SetTimeout (const STimeout *timeout, EIO_Event direction=eIO_ReadWrite)

const STimeout *	GetTimeout (EIO_Event direction=eIO_Read) const

EIO_Status	AsyncConnect (void *handle_buf, size_t handle_size)

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

Public Member Functions inherited from CRPCClient_Base
	CRPCClient_Base (const string &service, ESerialDataFormat format)

	CRPCClient_Base (const string &service, ESerialDataFormat format, unsigned int try_limit)

virtual	~CRPCClient_Base (void)

void	Connect (void)

void	Disconnect (void)

void	Reset (void)

void	SetArgs (const string &args)
	Set additional connection arguments. More...

void	SetArgs (const CUrlArgs &args)

const string &	GetArgs (void) const
	Get additional connection arguments. More...

const string &	GetService (void) const

void	SetService (const string &service)

ESerialDataFormat	GetFormat (void) const

void	SetFormat (ESerialDataFormat fmt)

unsigned int	GetTryLimit (void) const
	Get number of request attempts. More...

void	SetTryLimit (unsigned int n)

unsigned int	GetRetryLimit (void) const

void	SetRetryLimit (unsigned int n)

const CTimeSpan	GetRetryDelay (void) const
	Get retry delay. More...

void	SetRetryDelay (const CTimeSpan &ts)

void	SetCanceledCallback (const ICanceled *canceled)
	Set request canceler. More...

bool	IsCanceled (void) const

Private Types
typedef CID1Client_Base	Tparent

Private Member Functions
	CID1Client (const CID1Client &value)

CID1Client &	operator= (const CID1Client &value)

Private Attributes
bool	m_AllowDeadEntries

Additional Inherited Members
Public Types inherited from CID1Client_Base
typedef CID1server_request	TRequest

typedef CID1server_back	TReply

typedef TRequest	TRequestChoice

typedef TReply	TReplyChoice

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 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 CID1Client_Base
void	x_Connect (void)
	These run with m_Mutex already acquired. More...

void	x_Disconnect (void)
	Disconnect as cleanly as possible. More...

Protected Member Functions inherited from CRPCClient< CID1server_request, CID1server_back >
virtual string	GetAffinity (const CID1server_request &) const

virtual void	x_WriteRequest (CObjectOStream &out, const CSerialObject &request) override

virtual void	x_ReadReply (CObjectIStream &in, CSerialObject &reply) override

virtual string	x_GetAffinity (const CSerialObject &request) const override

void	x_ConnectURL (const string &url)
	Connect to a URL. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Protected Member Functions inherited from CRPCClient_Base
void	SetAffinity (const string &affinity)

void	x_SetStream (CNcbiIostream *stream)

void	x_Ask (const CSerialObject &request, CSerialObject &reply)

virtual bool	x_ShouldRetry (unsigned int tries)

CTimeSpan	x_GetRetryDelay (double max_delay) const

Protected Member Functions inherited from CConnIniter
	CConnIniter (void)

Static Protected Member Functions inherited from CRPCClient< CID1server_request, CID1server_back >
static EHTTP_HeaderParse	sx_ParseHeader (const char http_header, void user_data, int server_error)

static bool	sx_IsSpecial (const STimeout *timeout)

Static Protected Member Functions inherited from CRPCClient_Base
static const char *	GetContentTypeHeader (ESerialDataFormat format)

Protected Attributes inherited from CRPCClient< CID1server_request, CID1server_back >
const STimeout *	m_Timeout
	Cloned if not special. More...

Protected Attributes inherited from CRPCClient_Base
string	m_Service
	Used by default Connect(). More...

string	m_Args

unique_ptr< CNcbiIostream >	m_Stream

unique_ptr< CObjectIStream >	m_In

unique_ptr< CObjectOStream >	m_Out

string	m_Affinity

unsigned int	m_TryLimit

CHttpRetryContext	m_RetryCtx

CConstIRef< ICanceled >	m_Canceler

Detailed Description

Definition at line 50 of file id1_client.hpp.

Member Typedef Documentation

◆ Tparent

typedef CID1Client_Base CID1Client::Tparent

private

Definition at line 52 of file id1_client.hpp.

Constructor & Destructor Documentation

◆ CID1Client() [1/2]

CID1Client::CID1Client ( void )

inline

Definition at line 93 of file id1_client.hpp.

◆ ~CID1Client()

CID1Client::~CID1Client ( void )

Definition at line 116 of file id1_client.cpp.

◆ CID1Client() [2/2]

CID1Client::CID1Client ( const CID1Client & value )

private

Member Function Documentation

◆ Ask() [1/2]

void CID1Client::Ask	(	const TRequest &	request,
		TReply &	reply
	)

inlinevirtual

Reimplemented from CID1Client_Base.

Definition at line 64 of file id1_client.hpp.

References CID1Client_Base::Ask().

◆ Ask() [2/2]

void CID1Client::Ask	(	const TRequest &	request,
		CID1Client::TReply &	reply,
		TReplyChoice::E_Choice	wanted
	)

virtual

Reimplemented from CID1Client_Base.

Definition at line 54 of file id1_client.cpp.

References eUnknown, CID1server_back::GetErrorString(), CID1server_back_Base::IsError(), NCBI_THROW, CID1server_back_Base::ThrowInvalidSelection(), and CID1server_back_Base::Which().

◆ AskGetsefromgi()

CRef< CSeq_entry > CID1Client::AskGetsefromgi	(	const CID1server_maxcomplex &	req,
		CID1Client::TReply *	reply = `0`
	)

virtual

Reimplemented from CID1Client_Base.

Definition at line 69 of file id1_client.cpp.

References CID1Client_Base::AskGetsefromgi(), CID1server_back_Base::IsGotdeadseqentry(), m_AllowDeadEntries, and CID1server_back_Base::SetGotdeadseqentry().

Referenced by FetchEntry().

◆ FetchEntry() [1/3]

CRef< CSeq_entry > CID1Client::FetchEntry	(	const CSeq_id &	id,
		int	max_complexity = `0`
	)

Definition at line 97 of file id1_client.cpp.

References CID1Client_Base::AskGetgi(), FetchEntry(), and ZERO_GI.

◆ FetchEntry() [2/3]

CRef< CSeq_entry > CID1Client::FetchEntry	(	const string &	id_string,
		int	max_complexity = `0`
	)

Definition at line 107 of file id1_client.cpp.

References FetchEntry().

◆ FetchEntry() [3/3]

CRef< CSeq_entry > CID1Client::FetchEntry	(	TGi	gi,
		int	max_complexity = `0`
	)

Definition at line 88 of file id1_client.cpp.

References AskGetsefromgi().

Referenced by FetchEntry().

◆ GetAllowDeadEntries()

bool CID1Client::GetAllowDeadEntries ( void )

inline

Definition at line 68 of file id1_client.hpp.

References m_AllowDeadEntries.

◆ operator=()

CID1Client& CID1Client::operator= ( const CID1Client & value )

private

◆ SetAllowDeadEntries()

void CID1Client::SetAllowDeadEntries ( bool ok )

inline

Definition at line 67 of file id1_client.hpp.

References m_AllowDeadEntries, and ok.

Referenced by CId1FetchApp::Run().

Member Data Documentation

◆ m_AllowDeadEntries

bool CID1Client::m_AllowDeadEntries

private

Definition at line 79 of file id1_client.hpp.

Referenced by AskGetsefromgi(), GetAllowDeadEntries(), and SetAllowDeadEntries().

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

include/objects/id1/id1_client.hpp
src/objects/id1/id1_client.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CID1Client() [1/2]

◆ ~CID1Client()

◆ CID1Client() [2/2]

Member Function Documentation

◆ Ask() [1/2]

◆ Ask() [2/2]

◆ AskGetsefromgi()

◆ FetchEntry() [1/3]

◆ FetchEntry() [2/3]

◆ FetchEntry() [3/3]

◆ GetAllowDeadEntries()

◆ operator=()

◆ SetAllowDeadEntries()

Member Data Documentation

◆ m_AllowDeadEntries