NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ctlib::Command Class Reference

Search Toolkit Book for ctlib::Command

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

+ Collaboration diagram for ctlib::Command:

Public Member Functions

 Command (CTL_Connection &ctl_conn)
 
 ~Command (void)
 
CS_COMMANDGetNativeHandle (void) const
 
bool Open (CS_INT type, CS_INT option, const string &arg=kEmptyCStr)
 
bool GetDataInfo (CS_IODESC &desc)
 
bool SendData (CS_VOID *buff, CS_INT buff_len)
 
bool Send (void)
 
CS_RETCODE GetResults (CS_INT &res_type)
 
CS_RETCODE Fetch (void)
 

Protected Member Functions

const CTL_ConnectionGetCTLConn (void) const
 
CTL_ConnectionGetCTLConn (void)
 
void Drop (void)
 
void Close (void)
 

Private Attributes

CTL_Connectionm_CTL_Conn
 
CS_COMMANDm_Handle
 
bool m_IsAllocated
 
bool m_IsOpen
 

Detailed Description

Definition at line 203 of file interfaces.hpp.

Constructor & Destructor Documentation

◆ Command()

ctlib::Command::Command ( CTL_Connection ctl_conn)

◆ ~Command()

ctlib::Command::~Command ( void  )

Definition at line 455 of file context.cpp.

References Close(), Drop(), NCBI_CATCH_ALL_X, and NCBI_CURRENT_FUNCTION.

Member Function Documentation

◆ Close()

void ctlib::Command::Close ( void  )
protected

Definition at line 544 of file context.cpp.

References CTL_Connection::Check(), CS_CANCEL_ALL, ct_cancel(), GetCTLConn(), m_Handle, m_IsOpen, and NULL.

Referenced by ~Command().

◆ Drop()

void ctlib::Command::Drop ( void  )
protected

Definition at line 533 of file context.cpp.

References CTL_Connection::Check(), ct_cmd_drop(), GetCTLConn(), m_Handle, m_IsAllocated, and NULL.

Referenced by ~Command().

◆ Fetch()

CS_RETCODE ctlib::Command::Fetch ( void  )

Definition at line 521 of file context.cpp.

References CTL_Connection::Check(), CS_UNUSED, ct_fetch(), GetCTLConn(), and m_Handle.

◆ GetCTLConn() [1/2]

CTL_Connection& ctlib::Command::GetCTLConn ( void  )
inlineprotected

Definition at line 228 of file interfaces.hpp.

References _ASSERT.

◆ GetCTLConn() [2/2]

const CTL_Connection& ctlib::Command::GetCTLConn ( void  ) const
inlineprotected

Definition at line 223 of file interfaces.hpp.

References _ASSERT.

Referenced by Close(), Command(), Drop(), Fetch(), GetDataInfo(), GetResults(), Open(), Send(), and SendData().

◆ GetDataInfo()

bool ctlib::Command::GetDataInfo ( CS_IODESC desc)

◆ GetNativeHandle()

CS_COMMAND* ctlib::Command::GetNativeHandle ( void  ) const
inline

Definition at line 210 of file interfaces.hpp.

Referenced by Command().

◆ GetResults()

CS_RETCODE ctlib::Command::GetResults ( CS_INT res_type)

Definition at line 514 of file context.cpp.

References CTL_Connection::Check(), ct_results(), GetCTLConn(), and m_Handle.

◆ Open()

bool ctlib::Command::Open ( CS_INT  type,
CS_INT  option,
const string arg = kEmptyCStr 
)

◆ Send()

bool ctlib::Command::Send ( void  )

◆ SendData()

bool ctlib::Command::SendData ( CS_VOID buff,
CS_INT  buff_len 
)

Member Data Documentation

◆ m_CTL_Conn

CTL_Connection* ctlib::Command::m_CTL_Conn
private

Definition at line 238 of file interfaces.hpp.

◆ m_Handle

CS_COMMAND* ctlib::Command::m_Handle
private

Definition at line 239 of file interfaces.hpp.

Referenced by Close(), Command(), Drop(), Fetch(), GetDataInfo(), GetResults(), Open(), Send(), and SendData().

◆ m_IsAllocated

bool ctlib::Command::m_IsAllocated
private

Definition at line 240 of file interfaces.hpp.

Referenced by Command(), and Drop().

◆ m_IsOpen

bool ctlib::Command::m_IsOpen
private

Definition at line 241 of file interfaces.hpp.

Referenced by Close(), and Open().


The documentation for this class was generated from the following files:
Modified on Wed Feb 21 09:56:19 2024 by modify_doxy.py rev. 669887