CTL_SendDataCmd Class Reference

Search Toolkit Book for CTL_SendDataCmd

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

Inheritance diagram for CTL_SendDataCmd:

Collaboration diagram for CTL_SendDataCmd:

Protected Member Functions
	CTL_SendDataCmd (CTL_Connection &conn, I_BlobDescriptor &descr_in, size_t nof_bytes, bool log_it, bool dump_results)
virtual	~CTL_SendDataCmd (void)
void	Close (void)
virtual bool	Cancel (void)
	Cancel the command execution. More...
virtual size_t	SendChunk (const void *chunk_ptr, size_t nof_bytes)
	Send chunk of data to the server. More...
virtual CDB_Result *	Result (void)
	Get result set. More...
virtual bool	HasMoreResults (void) const
virtual int	RowCount (void) const
	Get the number of rows affected by the command Special case: negative on error or if there is no way that this command could ever affect any rows (like PRINT). More...
Protected Member Functions inherited from impl::CSendDataCmd
void	DumpResults (void)
	Dump the results of the command if result processor is installed for this connection, it will be called for each result set. More...
void	DetachSendDataIntf (void)
void	SetBytes2Go (size_t value)
Protected Member Functions inherited from impl::CCmdBase
void	SetWasSent (bool flag=true)
impl::CConnection &	GetConnImpl (void) const

Private Attributes
CDB_BlobDescriptor::ETDescriptorType	m_DescrType
bool	m_DumpResults
bool	m_UseUpdateWrite
Private Attributes inherited from CTL_CmdBase
int	m_RowCount
CRef< TDbgInfo >	m_DbgInfo

Friends
class	CTL_Connection

Additional Inherited Members
Public Member Functions inherited from impl::CSendDataCmd
	CSendDataCmd (impl::CConnection &conn, size_t nof_bytes)
virtual	~CSendDataCmd (void)
size_t	GetBytes2Go (void) const
Public Member Functions inherited from impl::CCmdBase
	CCmdBase (impl::CConnection &conn)
virtual	~CCmdBase ()
bool	WasSent (void) const
Public Member Functions inherited from impl::CCommand
virtual	~CCommand (void)
void	Release (void)
Static Public Member Functions inherited from impl::CCommand
static CDB_Result *	Create_Result (CResult &result)
Private Types inherited from CTL_CmdBase
enum	ECancelType { eAsyncCancel = CS_CANCEL_ATTN , eSyncCancel = CS_CANCEL_ALL }
typedef CTL_Connection::TDbgInfo	TDbgInfo
Private Member Functions inherited from CTL_LRCmd
	CTL_LRCmd (CTL_Connection &conn, const string &query)
virtual	~CTL_LRCmd (void)
CTL_RowResult *	MakeResultInternal (void)
CDB_Result *	MakeResult (void)
CS_RETCODE	CheckSFB (CS_RETCODE rc, const char *msg, unsigned int msg_num)
bool	SendInternal (void)
bool	x_Cancel (ECancelType cancel_type) override
Private Member Functions inherited from CTL_Cmd
	CTL_Cmd (CTL_Connection &conn, const string &query)
	CTL_Cmd (CTL_Connection &conn, const string &cursor_name, const string &query)
virtual	~CTL_Cmd (void)
CS_COMMAND *	x_GetSybaseCmd (void) const
void	SetSybaseCmd (CS_COMMAND *cmd)
bool	AssignCmdParam (CDB_Object &param, const string &param_name, CS_DATAFMT &param_fmt, bool declare_only=false)
void	GetRowCount (int *cnt)
CTL_RowResult &	GetResult (void)
void	DeleteResult (void)
void	DeleteResultInternal (void)
void	MarkEndOfReply (void)
bool	HaveResult (void) const
void	SetResult (CTL_RowResult *result)
CTL_RowResult *	MakeCursorResult (void)
CTL_RowResult *	MakeRowResult (void)
CTL_RowResult *	MakeParamResult (void)
CTL_RowResult *	MakeComputeResult (void)
CTL_RowResult *	MakeStatusResult (void)
bool	ProcessResultInternal (CDB_Result &res)
bool	ProcessResultInternal (CS_INT res_type)
CS_RETCODE	CheckSFB_Internal (CS_RETCODE rc, const char *msg, unsigned int msg_num)
void	DropSybaseCmd (void)
Private Member Functions inherited from CTL_CmdBase
	CTL_CmdBase (CTL_Connection &conn, const string &query)
	CTL_CmdBase (CTL_Connection &conn, const string &cursor_name, const string &query)
virtual	~CTL_CmdBase (void)
CS_RETCODE	Check (CS_RETCODE rc)
CTL_Connection &	GetConnection (void)
const CTL_Connection &	GetConnection (void) const
void	DropCmd (impl::CCommand &cmd)
bool	x_SendData (I_BlobDescriptor &desc, CDB_Stream &img, bool log_it=true)
CDB_SendDataCmd *	ConnSendDataCmd (I_BlobDescriptor &desc, size_t data_size, bool log_it=true, bool dump_results=true)
bool	IsMultibyteClientEncoding (void) const
EEncoding	GetClientEncoding (void) const
void	SetExecCntxInfo (const string &info)
const string &	GetExecCntxInfo (void) const
bool	IsDead (void) const
void	SetDead (bool flag=true)
void	CheckIsDead (void)
virtual void	SetHasFailed (bool flag=true)
const TDbgInfo &	GetDbgInfo (void) const
bool	GetTimedOut (void) const
void	SetTimedOut (bool val)
ERetriable	GetRetriable (void) const
void	SetRetriable (ERetriable val)
void	EnsureActiveStatus (void)
Private Member Functions inherited from impl::CBaseCmd
	CBaseCmd (impl::CConnection &conn, const string &query)
	CBaseCmd (impl::CConnection &conn, const string &cursor_name, const string &query)
virtual	~CBaseCmd (void)
virtual bool	Send (void)
	Send command to the server. More...
bool	WasCanceled (void) const
virtual bool	HasFailed (void) const
void	DumpResults (void)
	Dump the results of the command if result processor is installed for this connection, it will be called for each result set. More...
virtual CDBParams &	GetBindParams (void)
	Binding. More...
virtual CDBParams &	GetDefineParams (void)
	Get meta-information about defined parameters. More...
const CDBParams *	GetLastParams (void) const
bool	More (const string &query_text)
	Add more text to the language command. More...
const string &	GetQuery (void) const
string	GetCmdName (void) const
virtual void	SetHints (CTempString hints)
	Set hints by one call. More...
virtual void	AddHint (CDB_BCPInCmd::EBCP_Hints hint, unsigned int value)
	Add hint with value. More...
virtual void	AddOrderHint (CTempString columns)
	Add "ORDER" hint. More...
virtual bool	CommitBCPTrans (void)
	Complete batch – to store all rows transferred by far in this batch into the table. More...
virtual bool	EndBCP (void)
	Complete the BCP and store all rows transferred in last batch into the table. More...
unsigned int	GetRowsInCurrentBatch (void) const
void	DetachInterface (void)
void	SetRecompile (bool recompile=true)
	Set the "recompile before execute" flag for the stored proc. More...
bool	NeedToRecompile (void) const
const CDB_Params &	GetBindParamsImpl (void) const
CDB_Params &	GetBindParamsImpl (void)
const CDB_Params &	GetDefineParamsImpl (void) const
CDB_Params &	GetDefineParamsImpl (void)
virtual CDB_Result *	OpenCursor (void)
	Open the cursor. More...
virtual bool	Update (const string &table_name, const string &upd_query)
	Update the last fetched row. More...
virtual bool	UpdateBlob (unsigned int item_num, CDB_Stream &data, bool log_it=true)
virtual CDB_SendDataCmd *	SendDataCmd (unsigned int item_num, size_t size, bool log_it=true, bool dump_results=true)
virtual bool	Delete (const string &table_name)
	Delete the last fetched row. More...
virtual bool	CloseCursor (void)
	Close the cursor. More...
bool	CursorIsOpen (void) const
void	SetCursorOpen (bool flag=true)
bool	CursorIsDeclared (void) const
void	SetCursorDeclared (bool flag=true)
Private Member Functions inherited from impl::CCmdBase
	CCmdBase (impl::CConnection &conn)
virtual	~CCmdBase ()
bool	WasSent (void) const
void	SetWasSent (bool flag=true)
impl::CConnection &	GetConnImpl (void) const
Private Member Functions inherited from impl::CCommand
virtual	~CCommand (void)
void	Release (void)
Static Private Member Functions inherited from impl::CCommand
static CDB_Result *	Create_Result (CResult &result)

Detailed Description

Definition at line 1079 of file interfaces.hpp.

Constructor & Destructor Documentation

CTL_SendDataCmd()

CTL_SendDataCmd::CTL_SendDataCmd ( CTL_Connection &  conn, I_BlobDescriptor &  descr_in, size_t  nof_bytes, bool  log_it, bool  dump_results  )

protected

Definition at line 1729 of file connection.cpp.

References _ASSERT, CTL_CmdBase::Check(), CHECK_DRIVER_ERROR, CDB_BlobDescriptor::ColumnName(), CS_CANCEL_ALL, CS_COLUMN_DATA, CS_FALSE, CS_IMAGE_TYPE, CS_SEND_DATA_CMD, CS_SET, CS_SUCCEED, CS_TEXT_TYPE, CS_TRUE, CS_UNUSED, ct_cancel(), ct_command(), ct_data_info(), CTL_BLOB_DESCRIPTOR_TYPE_CURSOR, CTL_BLOB_DESCRIPTOR_TYPE_MAGNUM, DATABASE_DRIVER_ERROR, DATABASE_DRIVER_ERROR_EX, _cs_iodesc::datatype, CDB_BlobDescriptor::DescriptorType(), I_BlobDescriptor::DescriptorType(), CDB_BlobDescriptor::eBinary, CDB_BlobDescriptor::eText, CDB_BlobDescriptor::GetColumnType(), CTL_CmdBase::GetConnection(), CTL_CmdBase::GetDbgInfo(), CTL_CursorBlobDescriptor::IsValid(), _cs_iodesc::log_on_update, CTL_BlobDescriptor::m_Context, CTL_BlobDescriptor::m_Desc, m_DescrType, m_UseUpdateWrite, NULL, result, CDB_BlobDescriptor::SearchConditions(), CDB_BlobDescriptor::TableName(), _cs_iodesc::textptrlen, _cs_iodesc::total_txtlen, CTL_Connection::x_GetNativeBlobDescriptor(), and CTL_Cmd::x_GetSybaseCmd().

~CTL_SendDataCmd()

CTL_SendDataCmd::~CTL_SendDataCmd ( void  )

protectedvirtual

Definition at line 1962 of file connection.cpp.

References Cancel(), Close(), impl::CSendDataCmd::DetachSendDataIntf(), CTL_CmdBase::DropCmd(), NCBI_CATCH_ALL_X, and NCBI_CURRENT_FUNCTION.

Member Function Documentation

Cancel()

bool CTL_SendDataCmd::Cancel ( void  )

protectedvirtual

Cancel the command execution.

Reimplemented from CTL_LRCmd.

Definition at line 1941 of file connection.cpp.

References CTL_Connection::CancelFinished(), CTL_CmdBase::Check(), CS_CANCEL_ALL, ct_cancel(), impl::CSendDataCmd::GetBytes2Go(), CTL_CmdBase::GetConnection(), CTL_CmdBase::IsDead(), CTL_Connection::PrepareToCancel(), impl::CSendDataCmd::SetBytes2Go(), impl::CCmdBase::SetWasSent(), impl::CCmdBase::WasSent(), and CTL_Cmd::x_GetSybaseCmd().

Referenced by Close(), and ~CTL_SendDataCmd().

Close()

void CTL_SendDataCmd::Close ( void  )

protected

Definition at line 1978 of file connection.cpp.

References Cancel(), CTL_CmdBase::Check(), ct_cmd_drop(), impl::CSendDataCmd::DetachSendDataIntf(), impl::CBaseCmd::DumpResults(), NULL, CTL_Cmd::SetSybaseCmd(), and CTL_Cmd::x_GetSybaseCmd().

Referenced by ~CTL_SendDataCmd().

HasMoreResults()

bool CTL_SendDataCmd::HasMoreResults ( void  ) const

protectedvirtual

Reimplemented from impl::CSendDataCmd.

Definition at line 2000 of file connection.cpp.

References impl::CCmdBase::WasSent().

Result()

CDB_Result * CTL_SendDataCmd::Result ( void  )

protectedvirtual

Get result set.

Reimplemented from impl::CSendDataCmd.

Definition at line 1994 of file connection.cpp.

References CTL_LRCmd::MakeResult().

RowCount()

int CTL_SendDataCmd::RowCount ( void  ) const

protectedvirtual

Get the number of rows affected by the command Special case: negative on error or if there is no way that this command could ever affect any rows (like PRINT).

Implements impl::CBaseCmd.

Definition at line 2006 of file connection.cpp.

References CTL_CmdBase::m_RowCount.

SendChunk()

size_t CTL_SendDataCmd::SendChunk ( const void *  pChunk, size_t  nofBytes  )

protectedvirtual

Send chunk of data to the server.

Return number of bytes actually transferred to server.

Implements impl::CSendDataCmd.

Definition at line 1845 of file connection.cpp.

References _TROUBLE, CTL_Cmd::AssignCmdParam(), CTL_CmdBase::Check(), CHECK_DRIVER_ERROR, CTL_CmdBase::CheckIsDead(), CS_CANCEL_CURRENT, CS_END, CS_INPUTVALUE, CS_LANG_CMD, CS_SUCCEED, ct_cancel(), ct_command(), ct_send(), ct_send_data(), DATABASE_DRIVER_ERROR, impl::CBaseCmd::DumpResults(), CDB_BlobDescriptor::eBinary, CTL_CmdBase::EnsureActiveStatus(), impl::CSendDataCmd::GetBytes2Go(), CTL_CmdBase::GetDbgInfo(), impl::GetValidUTF8Len(), l(), m_DescrType, m_DumpResults, m_UseUpdateWrite, n, impl::CSendDataCmd::SetBytes2Go(), impl::CCmdBase::SetWasSent(), _cs_datafmt::status, and CTL_Cmd::x_GetSybaseCmd().

Friends And Related Function Documentation

CTL_Connection

friend class CTL_Connection

friend

Definition at line 1081 of file interfaces.hpp.

Member Data Documentation

m_DescrType

CDB_BlobDescriptor::ETDescriptorType CTL_SendDataCmd::m_DescrType

private

Definition at line 1101 of file interfaces.hpp.

Referenced by CTL_SendDataCmd(), and SendChunk().

m_DumpResults

bool CTL_SendDataCmd::m_DumpResults

private

Definition at line 1106 of file interfaces.hpp.

Referenced by SendChunk().

m_UseUpdateWrite

bool CTL_SendDataCmd::m_UseUpdateWrite

private

Definition at line 1107 of file interfaces.hpp.

Referenced by CTL_SendDataCmd(), and SendChunk().

---

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

• include/dbapi/driver/ctlib/interfaces.hpp
• src/dbapi/driver/ctlib/connection.cpp