Search Toolkit Book for CTL_Connection

#include <dbapi/driver/ctlib/interfaces.hpp>

Inheritance diagram for CTL_Connection:

Collaboration diagram for CTL_Connection:

Classes
class	CCancelModeGuard

Public Member Functions
CS_RETCODE	Check (CS_RETCODE rc)

CS_RETCODE	Check (CS_RETCODE rc, const TDbgInfo &dbg_info)

CS_INT	GetBLKVersion (void) const

const CTLibContext &	GetCTLibContext (void) const

CTLibContext &	GetCTLibContext (void)

ctlib::Connection &	GetNativeConnection (void)

const ctlib::Connection &	GetNativeConnection (void) const

virtual bool	IsAlive (void)
	Check out if connection is alive (this function doesn't ping the server, it just checks the status of connection which was set by the last i/o operation) More...

bool	IsOpen (void)

void	DeferTimeout (void)

Public Member Functions inherited from impl::CConnection
	CConnection (CDriverContext &dc, const CDBConnParams &params, bool isBCPable=false)

virtual	~CConnection (void)

CDB_ResultProcessor *	GetResultProcessor (void) const

CDriverContext &	GetCDriverContext (void)

const CDriverContext &	GetCDriverContext (void) const

bool	IsMultibyteClientEncoding (void) const

EEncoding	GetClientEncoding (void) const

void	SetExtraMsg (const string &msg)

const string &	GetExtraMsg (void) const

const string &	GetServerName (void) const

const string &	GetUserName (void) const

const string &	GetPassword (void) const

const string &	GetDatabaseName (void) const

const string &	GetRequestedServer (void) const

bool	IsOpeningFinished (void) const

void	FinishOpening (void)

bool	IsValid (void) const

virtual void	SetDatabaseName (const string &name)

void	Invalidate (void)

const string &	ServerName (void) const
	Get the server name, user login name, and password. More...

Uint4	Host (void) const

Uint2	Port (void) const

const string &	UserName (void) const

const string &	Password (void) const

bool	IsReusable (void) const
	Check if this connection is a reusable one. More...

const string &	PoolName (void) const
	Find out which connection pool this connection belongs to. More...

I_DriverContext *	Context (void) const
	Get pointer to the driver context. More...

void	PushMsgHandler (CDB_UserHandler *h, EOwnership ownership=eNoOwnership)
	Put the message handler into message handler stack. More...

void	PopMsgHandler (CDB_UserHandler *h)
	Remove the message handler (and all above it) from the stack. More...

CDB_ResultProcessor *	SetResultProcessor (CDB_ResultProcessor *rp)

virtual void	SetBlobSize (size_t nof_bytes)

void	SetTextImageSize (size_t nof_bytes)

virtual string	GetDriverName (void) const

CDBConnParams::EServerType	GetServerType (void)

CDB_BigDateTime::ESyntax	GetDateTimeSyntax (void)

CDBConnParams::EServerType	CalculateServerType (CDBConnParams::EServerType server_type)

void	SetUserData (CObject *data)

Public Member Functions inherited from I_ConnectionExtra
virtual	~I_ConnectionExtra (void)

template<typename T >
T *	GetUserData (void)

template<typename T >
const T *	GetUserData (void) const

Protected Member Functions
	CTL_Connection (CTLibContext &cntx, const CDBConnParams &params)

virtual	~CTL_Connection (void)

virtual CDB_LangCmd *	LangCmd (const string &lang_query)
	These methods: LangCmd(), RPC(), BCPIn(), Cursor() and SendDataCmd() create and return a "command" object, register it for later use with this (and only this!) connection. More...

virtual CDB_RPCCmd *	RPC (const string &rpc_name)
	Remote procedure call. More...

virtual CDB_BCPInCmd *	BCPIn (const string &table_name)
	"Bulk copy in" command More...

virtual CDB_CursorCmd *	Cursor (const string &cursor_name, const string &query, unsigned int batch_size=1)
	Cursor. More...

virtual CDB_SendDataCmd *	SendDataCmd (I_BlobDescriptor &desc, size_t data_size, bool log_it=true, bool dump_results=true)
	"Send-data" command More...

virtual bool	SendData (I_BlobDescriptor &desc, CDB_Stream &lob, bool log_it=true)
	Shortcut to send text and image to the server without using the "Send-data" command (SendDataCmd) More...

virtual bool	Refresh (void)
	Reset the connection to the "ready" state (cancel all active commands) More...

virtual I_DriverContext::TConnectionMode	ConnectMode (void) const
	Get the bitmask for the connection mode (BCP, secure login, ...) More...

CTL_LangCmd *	xLangCmd (const string &lang_query)

virtual bool	Abort (void)
	abort the connection Attention: it is not recommended to use this method unless you absolutely have to. More...

virtual bool	Close (void)
	Close an open connection. More...

CS_RETCODE	CheckWhileOpening (CS_RETCODE rc)

CS_RETCODE	CheckSFB (CS_RETCODE rc, const char *msg, unsigned int msg_num)

bool	IsDead (void) const

void	SetDead (bool flag=true)

const TDbgInfo &	GetDbgInfo (void) const

virtual void	SetTimeout (size_t nof_secs)

virtual void	SetCancelTimeout (size_t nof_secs)

virtual size_t	GetTimeout (void) const

virtual size_t	GetCancelTimeout (void) const

virtual unsigned int	GetRowsInCurrentBatch (void) const

size_t	PrepareToCancel (void)

void	CancelFinished (size_t was_timeout)

bool	IsCancelInProgress (void) const

virtual TSockHandle	GetLowLevelHandle (void) const
	Get OS handle of the socket represented by the connection. More...

virtual string	GetVersionString (void) const

void	CompleteBlobDescriptor (I_BlobDescriptor &desc, const string &cursor_name, int item_num)

void	CompleteBlobDescriptors (vector< I_BlobDescriptor * > &descs, const string &cursor_name)

Protected Member Functions inherited from impl::CConnection
CDB_LangCmd *	Create_LangCmd (CBaseCmd &lang_cmd)
	These methods to allow the children of CConnection to create various command-objects. More...

CDB_RPCCmd *	Create_RPCCmd (CBaseCmd &rpc_cmd)

CDB_BCPInCmd *	Create_BCPInCmd (CBaseCmd &bcpin_cmd)

CDB_CursorCmd *	Create_CursorCmd (CBaseCmd &cursor_cmd)

CDB_SendDataCmd *	Create_SendDataCmd (CSendDataCmd &senddata_cmd)

void	Release (void)

const CDBHandlerStack &	GetMsgHandlers (void) const

CDBHandlerStack &	GetMsgHandlers (void)

void	DropCmd (impl::CCommand &cmd)

void	DeleteAllCommands (void)

void	AttachTo (CDB_Connection *interface)

void	ReleaseInterface (void)

void	DetachResultProcessor (void)

void	CheckCanOpen (void)

void	MarkClosed (void)

unsigned int	GetReuseCount (void) const

bool	IsBCPable (void) const

bool	HasSecureLogin (void) const

TDbgInfo &	SetDbgInfo (void)

void	SetServerType (CDBConnParams::EServerType type)

const CDBHandlerStack &	GetOpeningMsgHandlers (void) const

CObject *	x_GetUserData (void) const

void	x_RecordServer (const CDBServer &server)

void	x_DisableReuse (void)

Private Member Functions
void	x_LoadTextPtrProcs (void)

void	x_CmdAlloc (CS_COMMAND **cmd)

void	x_SetExtraMsg (const I_BlobDescriptor &descr, size_t data_size)

bool	x_SendData (I_BlobDescriptor &desc, CDB_Stream &img, bool log_it=true)

bool	x_SendUpdateWrite (CDB_BlobDescriptor &desc, CDB_Stream &img, size_t size)

I_BlobDescriptor *	x_GetNativeBlobDescriptor (const CDB_BlobDescriptor &d)

bool	x_IsLegacyBlobColumnType (const string &table_name, const string &column_name)

CS_CONNECTION *	x_GetSybaseConn (void) const

bool	x_ProcessResultInternal (CS_COMMAND *cmd, CS_INT res_type)

const CDBParams *	GetLastParams (void) const

Private Attributes
CTLibContext *	m_Cntx

CTL_CmdBase *	m_ActiveCmd

ctlib::Connection	m_Handle

int	m_TDSVersion

bool	m_TextPtrProcsLoaded

bool	m_CancelInProgress

bool	m_CancelRequested

unsigned int	m_ActivityLevel

CMutex	m_CancelLogisticsMutex

Friends
class	CTLibContext

class	ctlib::Connection

class	ncbi::CDB_Connection

class	CTL_Cmd

class	CTL_CmdBase

class	CTL_LRCmd

class	CTL_LangCmd

class	CTL_RPCCmd

class	CTL_SendDataCmd

class	CTL_BCPInCmd

class	CTL_CursorCmd

class	CTL_CursorCmdExpl

class	CTL_CursorResultExpl

class	CTL_RowResult

class	CCancelModeGuard

Additional Inherited Members
Public Types inherited from impl::CConnection
typedef CDB_Exception::SContext	TDbgInfo

Public Types inherited from I_ConnectionExtra
typedef SOCKET	TSockHandle

Static Protected Member Functions inherited from impl::CConnection
static CDB_Result *	Create_Result (impl::CResult &result)

Detailed Description

Definition at line 374 of file interfaces.hpp.

Constructor & Destructor Documentation

◆ CTL_Connection()

CTL_Connection::CTL_Connection	(	CTLibContext &	cntx,
		const CDBConnParams &	params
	)

protected

Definition at line 158 of file connection.cpp.

References Check(), CheckWhileOpening(), CS_APPNAME, CS_BULK_LOGIN, CS_CLIENTMSG_CB, CS_GET, CS_HOSTNAME, CS_LOC_PROP, CS_LOGIN_TIMEOUT, CS_NO_LIMIT, CS_NULLTERM, CS_PACKETSIZE, CS_PASSWORD, CS_SEC_ENCRYPTION, CS_SERVERMSG_CB, CS_SET, CS_SUCCEED, CS_TDS_50, CS_TDS_70, CS_TDS_71, CS_TDS_72, CS_TDS_73, CS_TDS_74, CS_TDS_VERSION, CS_TIMEOUT, CS_TRUE, CS_UNUSED, CS_USERDATA, CS_USERNAME, CS_VERSION_100, CS_VERSION_110, CS_VERSION_125, ct_callback(), ct_con_props(), CTLibContext::CTLIB_cterr_handler(), CTLibContext::CTLIB_srverr_handler(), data, DATABASE_DRIVER_ERROR, FTDS_IN_USE, impl::CConnection::GetCDriverContext(), GetCTLibContext(), GetDbgInfo(), CTLibContext::GetLocale(), CTLibContext::GetLoginLoopDelay(), CTLibContext::GetLoginRetryCount(), ctlib::Connection::GetNativeHandle(), CTLibContext::GetPacketSize(), CDBConnParams::GetParam(), CDBConnParams::GetPassword(), CDBConnParams::GetProtocolVersion(), CDBConnParams::GetServerName(), CTLibContext::GetTDSVersion(), CDBConnParams::GetUserName(), m_Handle, m_TDSVersion, NULL, ctlib::Connection::Open(), impl::CConnection::SetServerType(), ncbi::grid::netcache::search::fields::size, NStr::StringToNumeric(), tds, _cs_connection::tds_socket, tds_version, and x_GetSybaseConn().

◆ ~CTL_Connection()

CTL_Connection::~CTL_Connection ( void )

protectedvirtual

Definition at line 941 of file connection.cpp.

References Close(), m_ActiveCmd, CTL_CmdBase::m_IsActive, NCBI_CATCH_ALL_X, and NCBI_CURRENT_FUNCTION.

Member Function Documentation

◆ Abort()

bool CTL_Connection::Abort ( void )

protectedvirtual

abort the connection Attention: it is not recommended to use this method unless you absolutely have to.

The expected implementation is - close underlying file descriptor[s] without destroing any objects associated with a connection. Returns: true - if succeed false - if not

Implements impl::CConnection.

Definition at line 1472 of file connection.cpp.

References Check(), close(), CS_GET, CS_SUCCEED, CS_UNUSED, ct_con_props(), impl::CConnection::MarkClosed(), and x_GetSybaseConn().

◆ BCPIn()

CDB_BCPInCmd * CTL_Connection::BCPIn ( const string & table_name )

protectedvirtual

"Bulk copy in" command

Implements impl::CConnection.

Definition at line 823 of file connection.cpp.

References impl::CConnection::Create_BCPInCmd(), CTL_BCPInCmd, impl::CConnection::SetExtraMsg(), and table_name.

◆ CancelFinished()

void CTL_Connection::CancelFinished ( size_t was_timeout )

protected

Definition at line 631 of file connection.cpp.

References m_CancelInProgress, and SetTimeout().

Referenced by CTL_BCPInCmd::Cancel(), CTL_SendDataCmd::Cancel(), and CTL_LRCmd::x_Cancel().

◆ Check() [1/2]

CS_RETCODE CTL_Connection::Check ( CS_RETCODE rc )

◆ Check() [2/2]

CS_RETCODE CTL_Connection::Check	(	CS_RETCODE	rc,
		const TDbgInfo &	dbg_info
	)

Definition at line 469 of file connection.cpp.

References GetCTLExceptionStorage(), GetLastParams(), impl::CConnection::GetMsgHandlers(), and impl::CDBExceptionStorage::Handle().

◆ CheckSFB()

CS_RETCODE CTL_Connection::CheckSFB	(	CS_RETCODE	rc,
		const char *	msg,
		unsigned int	msg_num
	)

protected

Definition at line 490 of file connection.cpp.

References Check(), CS_BUSY, CS_FAIL, CS_SUCCEED, DATABASE_DRIVER_ERROR, IsAlive(), and msg().

Referenced by x_CmdAlloc().

◆ CheckWhileOpening()

CS_RETCODE CTL_Connection::CheckWhileOpening ( CS_RETCODE rc )

protected

Definition at line 478 of file connection.cpp.

References CTLibContext::Check(), GetCTLExceptionStorage(), GetCTLibContext(), GetDbgInfo(), GetLastParams(), impl::CConnection::GetOpeningMsgHandlers(), impl::CDBHandlerStack::GetSize(), and impl::CDBExceptionStorage::Handle().

Referenced by CTL_Connection().

◆ Close()

bool CTL_Connection::Close ( void )

protectedvirtual

Close an open connection.

Returns: true - if successfully closed an open connection. false - if not

Implements impl::CConnection.

Definition at line 1494 of file connection.cpp.

References CTLibContext::Check(), ctlib::Connection::Close(), CS_SET, CS_USERDATA, ct_con_props(), ctlib::Connection::Drop(), GetCTLExceptionStorage(), GetCTLibContext(), ctlib::Connection::IsOpen(), m_Handle, impl::CConnection::MarkClosed(), NULL, Refresh(), impl::CDBExceptionStorage::SetClosingConnect(), tds, _cs_connection::tds_socket, and x_GetSybaseConn().

Referenced by ~CTL_Connection().

◆ CompleteBlobDescriptor()

void CTL_Connection::CompleteBlobDescriptor	(	I_BlobDescriptor &	desc,
		const string &	cursor_name,
		int	item_num
	)

protected

Definition at line 691 of file connection.cpp.

References CDBParams::Bind(), CHECK_DRIVER_ERROR, cmd, CS_TP_SIZE, CTL_BLOB_DESCRIPTOR_TYPE_MAGNUM, CDB_VarBinary::Data(), I_BlobDescriptor::DescriptorType(), eDB_ParamResult, CDB_Object::IsNULL(), CTL_BlobDescriptor::m_Desc, min(), NULL, result, RPC(), CDB_VarBinary::Size(), util::strcmp(), _cs_iodesc::textptr, _cs_iodesc::textptrlen, and x_LoadTextPtrProcs().

◆ CompleteBlobDescriptors()

void CTL_Connection::CompleteBlobDescriptors	(	vector< I_BlobDescriptor * > &	descs,
		const string &	cursor_name
	)

protected

Definition at line 744 of file connection.cpp.

References _ASSERT, CDB_Object::AssignNULL(), CDBParams::Bind(), CHECK_DRIVER_ERROR, cmd, CS_TP_SIZE, CTL_BLOB_DESCRIPTOR_TYPE_MAGNUM, CDB_VarBinary::Data(), eDB_RowResult, i, CDB_Object::IsNULL(), min(), NULL, result, RPC(), CDB_VarBinary::Size(), _cs_iodesc::textptr, _cs_iodesc::textptrlen, CDB_Int::Value(), and x_LoadTextPtrProcs().

Referenced by CTL_CursorResultExpl::Fetch().

◆ ConnectMode()

I_DriverContext::TConnectionMode CTL_Connection::ConnectMode ( void ) const

protectedvirtual

Get the bitmask for the connection mode (BCP, secure login, ...)

Implements impl::CConnection.

Definition at line 930 of file connection.cpp.

References I_DriverContext::fBcpIn, I_DriverContext::fPasswordEncrypted, and impl::CConnection::HasSecureLogin().

◆ Cursor()

CDB_CursorCmd * CTL_Connection::Cursor	(	const string &	cursor_name,
		const string &	query,
		unsigned int	batch_size = `1`
	)

protectedvirtual

Cursor.

Implements impl::CConnection.

Definition at line 837 of file connection.cpp.

References impl::CConnection::Create_CursorCmd(), CTL_CursorCmd, CTL_CursorCmdExpl, query, and impl::CConnection::SetExtraMsg().

◆ DeferTimeout()

void CTL_Connection::DeferTimeout ( void )

Definition at line 1662 of file connection.cpp.

Referenced by CTL_RowResult::CheckIsDead().

◆ GetBLKVersion()

CS_INT CTL_Connection::GetBLKVersion ( void ) const

Definition at line 514 of file connection.cpp.

References _ASSERT, BLK_VERSION_100, BLK_VERSION_110, BLK_VERSION_125, BLK_VERSION_150, BLK_VERSION_155, BLK_VERSION_157, BLK_VERSION_160, CS_VERSION_100, CS_VERSION_110, CS_VERSION_125, CS_VERSION_150, CS_VERSION_155, CS_VERSION_157, CS_VERSION_160, CTLibContext::GetTDSVersion(), m_Cntx, and tds_version.

◆ GetCancelTimeout()

size_t CTL_Connection::GetCancelTimeout ( void ) const

protectedvirtual

Reimplemented from impl::CConnection.

Definition at line 615 of file connection.cpp.

References impl::CDriverContext::GetCancelTimeout(), and GetCTLibContext().

Referenced by PrepareToCancel().

◆ GetCTLibContext() [1/2]

CTLibContext& CTL_Connection::GetCTLibContext ( void )

inline

Definition at line 406 of file interfaces.hpp.

References _ASSERT.

◆ GetCTLibContext() [2/2]

const CTLibContext& CTL_Connection::GetCTLibContext ( void ) const

inline

Definition at line 401 of file interfaces.hpp.

References _ASSERT.

Referenced by CTL_Cmd::AssignCmdParam(), CheckWhileOpening(), Close(), CTL_Connection(), GetCancelTimeout(), CTL_RowResult::GetItemInternal(), GetTimeout(), GetVersionString(), PrepareToCancel(), CTL_CursorResultExpl::ReadItem(), and SetCancelTimeout().

◆ GetDbgInfo()

const CTL_Connection::TDbgInfo & CTL_Connection::GetDbgInfo ( void ) const

inlineprotectedvirtual

Reimplemented from impl::CConnection.

Definition at line 1399 of file interfaces.hpp.

References GetDbgInfo.

Referenced by Check(), CheckWhileOpening(), CTL_Connection(), CTL_RowResult::GetDbgInfo(), x_GetNativeBlobDescriptor(), x_IsLegacyBlobColumnType(), and x_SendData().

◆ GetLastParams()

const CDBParams * CTL_Connection::GetLastParams ( void ) const

inlineprivate

Definition at line 1404 of file interfaces.hpp.

References NULL.

Referenced by Check(), CheckWhileOpening(), and CTL_RowResult::GetLastParams().

◆ GetLowLevelHandle()

I_ConnectionExtra::TSockHandle CTL_Connection::GetLowLevelHandle ( void ) const

protectedvirtual

Get OS handle of the socket represented by the connection.

Reimplemented from impl::CConnection.

Definition at line 639 of file connection.cpp.

References impl::CConnection::GetLowLevelHandle(), and x_GetSybaseConn().

◆ GetNativeConnection() [1/2]

ctlib::Connection& CTL_Connection::GetNativeConnection ( void )

inline

Definition at line 412 of file interfaces.hpp.

◆ GetNativeConnection() [2/2]

const ctlib::Connection& CTL_Connection::GetNativeConnection ( void ) const

inline

Definition at line 416 of file interfaces.hpp.

◆ GetRowsInCurrentBatch()

unsigned int CTL_Connection::GetRowsInCurrentBatch ( void ) const

inlineprotectedvirtual

Reimplemented from impl::CConnection.

Definition at line 1409 of file interfaces.hpp.

References U.

◆ GetTimeout()

size_t CTL_Connection::GetTimeout ( void ) const

protectedvirtual

Reimplemented from impl::CConnection.

Definition at line 601 of file connection.cpp.

References CS_GET, CS_NO_LIMIT, CS_SUCCEED, CS_TIMEOUT, CS_UNUSED, ct_con_props(), GetCTLibContext(), CTLibContext::GetTimeout(), and x_GetSybaseConn().

Referenced by PrepareToCancel().

◆ GetVersionString()

string CTL_Connection::GetVersionString ( void ) const

protectedvirtual

Reimplemented from impl::CConnection.

Definition at line 649 of file connection.cpp.

References buffer, CS_FAIL, CS_GET, CS_VERSION, ct_config(), GetCTLibContext(), len, and result.

◆ IsAlive()

bool CTL_Connection::IsAlive ( void )

virtual

Check out if connection is alive (this function doesn't ping the server, it just checks the status of connection which was set by the last i/o operation)

Implements impl::CConnection.

Definition at line 575 of file connection.cpp.

References ctlib::Connection::IsAlive(), and m_Handle.

Referenced by CheckSFB().

◆ IsCancelInProgress()

bool CTL_Connection::IsCancelInProgress ( void ) const

inlineprotected

Definition at line 501 of file interfaces.hpp.

◆ IsDead()

bool CTL_Connection::IsDead ( void ) const

inlineprotected

Definition at line 480 of file interfaces.hpp.

References IsValid().

Referenced by CTL_RowResult::IsDead(), and x_SendData().

◆ IsOpen()

bool CTL_Connection::IsOpen ( void )

inline

Definition at line 422 of file interfaces.hpp.

◆ LangCmd()

CDB_LangCmd * CTL_Connection::LangCmd ( const string & lang_query )

protectedvirtual

These methods: LangCmd(), RPC(), BCPIn(), Cursor() and SendDataCmd() create and return a "command" object, register it for later use with this (and only this!) connection.

On error, an exception will be thrown (they never return NULL!). It is the user's responsibility to delete the returned "command" object. Language command

Implements impl::CConnection.

Definition at line 795 of file connection.cpp.

References impl::CConnection::Create_LangCmd(), CTL_LangCmd, and impl::CConnection::SetExtraMsg().

Referenced by CTL_CursorCmdExpl::Delete(), x_GetNativeBlobDescriptor(), x_IsLegacyBlobColumnType(), and x_SendUpdateWrite().