RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classimpl_1_1CConnection.html below:

NCBI C++ ToolKit: impl::CConnection Class Reference

Search Toolkit Book for impl::CConnection

#include <dbapi/driver/impl/dbapi_impl_connection.hpp>

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 virtual const TDbgInfo & GetDbgInfo (void) const const string & GetRequestedServer (void) const virtual bool IsAlive (void)=0 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 IsOpeningFinished (void) const void FinishOpening (void) bool IsValid (void) const virtual CDB_LangCmd * LangCmd (const string &lang_query)=0 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)=0 Remote procedure call. More...
virtual CDB_BCPInCmd * BCPIn (const string &table_name)=0 "Bulk copy in" command More...
virtual CDB_CursorCmd * Cursor (const string &cursor_name, const string &query, unsigned int batch_size=1)=0 Cursor. More...
virtual CDB_SendDataCmd * SendDataCmd (I_BlobDescriptor &desc, size_t data_size, bool log_it=true, bool dump_results=true)=0 "Send-data" command More...
virtual bool SendData (I_BlobDescriptor &desc, CDB_Stream &lob, bool log_it=true)=0 Shortcut to send text and image to the server without using the "Send-data" command (SendDataCmd) More...
virtual void SetDatabaseName (const string &name) virtual bool Refresh (void)=0 Reset the connection to the "ready" state (cancel all active commands) More...
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 virtual I_DriverContext::TConnectionMode ConnectMode (void) const =0 Get the bitmask for the connection mode (BCP, secure login, ...) More...
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 bool Abort (void)=0 abort the connection Attention: it is not recommended to use this method unless you absolutely have to. More...
virtual bool Close (void)=0 Close an open connection. More...
virtual void SetTimeout (size_t nof_secs)=0 virtual void SetCancelTimeout (size_t nof_secs)=0 virtual void SetBlobSize (size_t nof_bytes) void SetTextImageSize (size_t nof_bytes) virtual size_t GetTimeout (void) const virtual size_t GetCancelTimeout (void) const virtual TSockHandle GetLowLevelHandle (void) const Get OS handle of the socket represented by the connection. More...
virtual string GetDriverName (void) const virtual string GetVersionString (void) const virtual unsigned int GetRowsInCurrentBatch (void) const CDBConnParams::EServerType GetServerType (void) CDB_BigDateTime::ESyntax GetDateTimeSyntax (void) CDBConnParams::EServerType CalculateServerType (CDBConnParams::EServerType server_type) void SetUserData (CObject *data) ◆ TCommandList ◆ TDbgInfo ◆ CConnection()

Definition at line 90 of file dbapi_impl_connection.cpp.

References _ASSERT, CheckCanOpen(), impl::CDriverContext::GetConnHandlerStack(), CDBConnParams::GetOpeningMsgHandlers(), CDBConnParams::GetParam(), impl::CDBHandlerStack::GetSize(), kMax_UInt, m_MsgHandlers, m_OpeningMsgHandlers, m_PoolIdleTimeParam, m_PoolMaxConnUse, m_PoolMaxSize, m_PoolMinSize, NStr::StringToDouble(), and NStr::StringToUInt().

◆ ~CConnection() CConnection::~CConnection ( void ) virtual ◆ Abort() virtual bool impl::CConnection::Abort ( void ) pure virtual

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

Implemented in CODBC_Connection, CTL_Connection, and CMySQL_Connection.

Referenced by CDB_Connection::Abort().

◆ AttachTo() ◆ BCPIn() ◆ CalculateServerType() ◆ CheckCanOpen() void CConnection::CheckCanOpen ( void ) protected

Definition at line 153 of file dbapi_impl_connection.cpp.

References impl::CDriverContext::CloseOldIdleConns(), impl::CDriverContext::CloseUnusedConnections(), DATABASE_DRIVER_ERROR, ERR_POST_X_ONCE, CDbapiConnMgr::Instance(), kEmptyStr, m_DriverContext, m_Opened, MarkClosed(), msg(), and NStr::NumericToString().

Referenced by CConnection().

◆ Close() virtual bool impl::CConnection::Close ( void ) pure virtual ◆ ConnectMode() ◆ Context() ◆ Create_BCPInCmd() ◆ Create_CursorCmd() ◆ Create_LangCmd() ◆ Create_Result() ◆ Create_RPCCmd() ◆ Create_SendDataCmd() ◆ Cursor() ◆ DeleteAllCommands() void CConnection::DeleteAllCommands ( void ) protected ◆ DetachResultProcessor() void CConnection::DetachResultProcessor ( void ) protected ◆ DropCmd() ◆ FinishOpening() void impl::CConnection::FinishOpening ( void ) inline ◆ GetCancelTimeout() size_t CConnection::GetCancelTimeout ( void ) const virtual ◆ GetCDriverContext() [1/2] ◆ GetCDriverContext() [2/2] ◆ GetClientEncoding() EEncoding CConnection::GetClientEncoding ( void ) const ◆ GetDatabaseName() const string & CConnection::GetDatabaseName ( void ) const ◆ GetDateTimeSyntax() ◆ GetDbgInfo() virtual const TDbgInfo& impl::CConnection::GetDbgInfo ( void ) const inlinevirtual ◆ GetDriverName() string CConnection::GetDriverName ( void ) const virtual ◆ GetExtraMsg() const string& impl::CConnection::GetExtraMsg ( void ) const inline ◆ GetLowLevelHandle() ◆ GetMsgHandlers() [1/2] ◆ GetMsgHandlers() [2/2] ◆ GetOpeningMsgHandlers() ◆ GetPassword() const string& impl::CConnection::GetPassword ( void ) const inline ◆ GetRequestedServer() const string& impl::CConnection::GetRequestedServer ( void ) const inline ◆ GetResultProcessor() ◆ GetReuseCount() unsigned int impl::CConnection::GetReuseCount ( void ) const inlineprotected ◆ GetRowsInCurrentBatch() virtual unsigned int impl::CConnection::GetRowsInCurrentBatch ( void ) const inlinevirtual ◆ GetServerName() const string& impl::CConnection::GetServerName ( void ) const inline ◆ GetServerType()

Definition at line 241 of file dbapi_impl_connection.cpp.

References CalculateServerType(), CDBConnParams::eUnknown, m_ServerType, and m_ServerTypeIsKnown.

Referenced by CTL_Cmd::AssignCmdParam(), CDB_Connection::Close(), CSimpleBlobStore::Fini(), CBlobStoreBase::GenReadQuery(), GetDateTimeSyntax(), CSimpleBlobStore::Init(), CTL_CursorCmdExpl::OpenCursor(), and CTL_Connection::x_IsLegacyBlobColumnType().

◆ GetTimeout() size_t CConnection::GetTimeout ( void ) const virtual ◆ GetUserName() const string& impl::CConnection::GetUserName ( void ) const inline ◆ GetVersionString() string CConnection::GetVersionString ( void ) const virtual ◆ HasSecureLogin() bool impl::CConnection::HasSecureLogin ( void ) const inlineprotected ◆ Host() Uint4 CConnection::Host ( void ) const ◆ Invalidate() void impl::CConnection::Invalidate ( void ) inline ◆ IsAlive() virtual bool impl::CConnection::IsAlive ( void ) pure virtual ◆ IsBCPable() bool impl::CConnection::IsBCPable ( void ) const inlineprotected ◆ IsMultibyteClientEncoding() bool CConnection::IsMultibyteClientEncoding ( void ) const ◆ IsOpeningFinished() bool impl::CConnection::IsOpeningFinished ( void ) const inline ◆ IsReusable() bool CConnection::IsReusable ( void ) const ◆ IsValid() bool impl::CConnection::IsValid ( void ) const inline ◆ LangCmd()

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

Implemented in CODBC_Connection, CMySQL_Connection, and CTL_Connection.

Referenced by CalculateServerType(), CDB_Connection::LangCmd(), SetDatabaseName(), and CAbortBlocker::~CAbortBlocker().

◆ MarkClosed() void CConnection::MarkClosed ( void ) protected ◆ Password() ◆ PoolName() ◆ PopMsgHandler() ◆ Port() Uint2 CConnection::Port ( void ) const ◆ PushMsgHandler() ◆ Refresh() virtual bool impl::CConnection::Refresh ( void ) pure virtual ◆ Release() void CConnection::Release ( void ) protected ◆ ReleaseInterface() void CConnection::ReleaseInterface ( void ) protected ◆ RPC() ◆ SendData() ◆ SendDataCmd() ◆ ServerName() ◆ SetBlobSize() void CConnection::SetBlobSize ( size_t nof_bytes ) virtual ◆ SetCancelTimeout() virtual void impl::CConnection::SetCancelTimeout ( size_t nof_secs ) pure virtual ◆ SetDatabaseName() void CConnection::SetDatabaseName ( const string & name ) virtual ◆ SetDbgInfo() TDbgInfo& impl::CConnection::SetDbgInfo ( void ) inlineprotected ◆ SetExtraMsg() void impl::CConnection::SetExtraMsg ( const string & msg ) inline ◆ SetResultProcessor() ◆ SetServerType() ◆ SetTextImageSize() void impl::CConnection::SetTextImageSize ( size_t nof_bytes ) inline ◆ SetTimeout() virtual void impl::CConnection::SetTimeout ( size_t nof_secs ) pure virtual ◆ SetUserData() void impl::CConnection::SetUserData ( CObject * data ) inlinevirtual ◆ UserName() ◆ x_DisableReuse() void CConnection::x_DisableReuse ( void ) protected ◆ x_GetUserData() CObject* impl::CConnection::x_GetUserData ( void ) const inlineprotectedvirtual ◆ x_RecordServer()

Reimplemented from I_ConnectionExtra.

Definition at line 443 of file dbapi_impl_connection.cpp.

References _TRACE, impl::ConvertN2A(), eEmptyGuard, CDBServer::GetHost(), CDBServer::GetName(), CDBServer::GetPort(), CGuard< Resource, Lock, Unlock, ReportExceptions >::Guard(), m_DriverContext, m_ExceptionContext, m_Host, impl::CDriverContext::m_PoolLock, m_Port, m_Reusable, ServerName(), and impl::CDriverContext::x_AdjustCounts().

◆ impl::CDriverContext ◆ ncbi::CDB_Connection ◆ ncbi::CDBConnectionFactory ◆ m_BCPable ◆ m_CleanupTime CTime impl::CConnection::m_CleanupTime private ◆ m_CMDs ◆ m_DriverContext ◆ m_ExceptionContext ◆ m_Host Uint4 impl::CConnection::m_Host private ◆ m_Interface ◆ m_MsgHandlers ◆ m_Opened bool impl::CConnection::m_Opened private ◆ m_OpenFinished bool impl::CConnection::m_OpenFinished private ◆ m_OpeningMsgHandlers ◆ m_Passwd ◆ m_Pool ◆ m_PoolIdleTimeParam CTimeSpan impl::CConnection::m_PoolIdleTimeParam private ◆ m_PoolMaxConnUse unsigned int impl::CConnection::m_PoolMaxConnUse private ◆ m_PoolMaxSize unsigned int impl::CConnection::m_PoolMaxSize private ◆ m_PoolMinSize unsigned int impl::CConnection::m_PoolMinSize private ◆ m_Port Uint2 impl::CConnection::m_Port private ◆ m_RequestedServer ◆ m_ResProc ◆ m_Reusable bool impl::CConnection::m_Reusable private ◆ m_ReuseCount unsigned int impl::CConnection::m_ReuseCount private ◆ m_SecureLogin ◆ m_ServerType ◆ m_ServerTypeIsKnown bool impl::CConnection::m_ServerTypeIsKnown private ◆ m_UserData ◆ m_Valid bool impl::CConnection::m_Valid private

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

include/dbapi/driver/impl/dbapi_impl_connection.hpp
src/dbapi/driver/dbapi_impl_connection.cpp

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4