Skip to main content
Previous sectionNext section

Reference for Connectivity and Inherited Proxy Classes

This chapter describes the classes that are most important for an understanding of how proxy classes interact with the Caché database.

Proxy Base Classes

The following classes are available:

Class InterSystems::Persistent_t

Base class used to generate persistent proxy classes. Inherits from Registered_t.

Constructor

Persistent_t()

Constructor is a PROTECTED member function (see Standard Proxy Class Methods).

   InterSystems::Persistent_t::Persistent_t
   ( ) [inline, protected] 
Copy code to clipboard

Member list

_delete()

   d_status Persistent_t::_delete
   (  Database * db, 
      const d_binary & oid, 
      int conc = -1 
   ) [static]
Copy code to clipboard
_is_null()

   bool InterSystems::Obj_t::_is_null
   (  ) const [inline, inherited]
Copy code to clipboard
create_new()

   static d_ref<Registered_t> InterSystems::Registered_t::create_new
   (  Database * db, 
      const_str_t init_val = 0,   // const_str_t is a typedef of const wchar_t*
      Db_err * err = 0 
   ) [inline, static, inherited]
Copy code to clipboard
delete_id()

   d_status Persistent_t::delete_id
   (  Database * db, 
      const_name_t cl_name,    // const_name_t is a typedef for const wchar_t*
      const_str_t id,          // const_str_t is a typedef of const wchar_t*
      int conc = -1 
   ) [static]
Copy code to clipboard
downgrade_concurrency()

   d_status Persistent_t::downgrade_concurrency
   (  int conc )
Copy code to clipboard
exists_id()

   bool Persistent_t::exists_id
   (  Database * db, 
      const_name_t cl_name,   // const_name_t is a typedef for const wchar_t*
      const_str_t id          // const_str_t is a typedef of const wchar_t*
   ) [static]
Copy code to clipboard
get_cl_name()

   const wchar_t* InterSystems::Obj_t::get_cl_name
   (  ) const [inline, inherited]
Copy code to clipboard
get_db()

   Database* InterSystems::Obj_t::get_db
   (  ) const [inline, inherited]
Copy code to clipboard
get_id()

   d_string Persistent_t::get_id
   (  ) const
Copy code to clipboard
get_ref()

   int InterSystems::Obj_t::get_ref
   (  ) const [inline, inherited]
Copy code to clipboard
get_val()

   const Oref_t& InterSystems::Obj_t::get_val
   (  ) const [inline, inherited]
Copy code to clipboard
id()

   d_string Persistent_t::id
   (  ) const
Copy code to clipboard
oid()

   d_oid InterSystems::Persistent_t::oid
   (  ) const [inline]
Copy code to clipboard
openref()

   static d_ref<Registered_t> InterSystems::Registered_t::openref
   (  Database * db, 
      int oref, 
      const_name_t cl_name    // const_name_t is a typedef for const wchar_t*
   ) [inline, static, inherited]
Copy code to clipboard
   static d_ref<Registered_t> InterSystems::Registered_t::openref
   (  t_istream & in, 
      Database * db 
   ) [inline, static, inherited]
Copy code to clipboard
reload()

   d_status Persistent_t::reload
   (  )
Copy code to clipboard
save()

   d_status Persistent_t::save
   (  int related = 1 ) const
Copy code to clipboard
to_xml()

   void InterSystems::Obj_t::to_xml
   (  xml_writer & out ) [inline, inherited]
Copy code to clipboard
upgrade_concurrency()

   d_status Persistent_t::upgrade_concurrency
   (  int conc )
Copy code to clipboard

Class InterSystems::Registered_t

Base class used to generate all serial proxy classes.

Constructor

Registered_t()

Constructor is a PROTECTED member function (see Standard Proxy Class Methods).

   InterSystems::Registered_t::Registered_t
   ( ) [inline, protected] 
Copy code to clipboard

Member list

_is_null()

   bool InterSystems::Obj_t::_is_null
   (  ) const [inline, inherited] 
Copy code to clipboard
get_cl_name()

   const wchar_t* InterSystems::Obj_t::get_cl_name
   (  ) const [inline, inherited] 
Copy code to clipboard
create_new()

   static d_ref&lt;Registered_t> InterSystems::Registered_t::create_new
   (  Database * db, 
      const_str_t init_val = 0,    // const_str_t is a typedef of const wchar_t*
      Db_err * err = 0 
   ) [inline, static] 
Copy code to clipboard
get_db()

   Database* InterSystems::Obj_t::get_db
   (  ) const [inline, inherited] 
Copy code to clipboard
get_ref()

   int InterSystems::Obj_t::get_ref
   (  ) const [inline, inherited] 
Copy code to clipboard
get_val()

   const Oref_t& InterSystems::Obj_t::get_val
   (  ) const [inline, inherited] 
Copy code to clipboard
openref()

   static d_ref&lt;Registered_t> InterSystems::Registered_t::openref
   (  Database * db, 
      int oref, 
      const_name_t cl_name    // const_name_t is a typedef for const wchar_t*
   ) [inline, static] 
Copy code to clipboard
   static d_ref&lt;Registered_t> InterSystems::Registered_t::openref
   (  t_istream & in, 
      Database * db 
   ) [inline, static] 
Copy code to clipboard
to_xml()

   void InterSystems::Obj_t::to_xml
   (  xml_writer & out ) [inline, inherited] 
Copy code to clipboard

Class InterSystems::LC_Persistent_t

This is the base class used to generate persistent classes for the Light C++ Binding. This class can only be used in Light C++ Binding applications.

Constructor

LC_Persistent_t

Both constructors are PROTECTED member functions (see Standard Proxy Class Methods).

   LC_Persistent_t::LC_Persistent_t
   ( ) [inline, protected]
Copy code to clipboard
   LC_Persistent_t::LC_Persistent_t
   (  Database * db,
      int  oref,
      const wchar_t * cl_name 
   ) [inline, protected]
Copy code to clipboard

Member list

_is_null()

Do not use (reserved for InterSystems internal use).

connect()

   void LC_Persistent_t::connect
   (  LC_Database * db ) 
Copy code to clipboard
detach()

   void LC_Persistent_t::detach ( ) 
Copy code to clipboard
disconnect()

   void LC_Persistent_t::disconnect ( ) 
Copy code to clipboard
get_cl_name()

Do not use (reserved for InterSystems internal use).

get_classname()

   virtual const unsigned char* LC_Persistent_t::get_classname
   (  ) const [pure virtual] 
Copy code to clipboard
get_classname_length()

   virtual int LC_Persistent_t::get_classname_length
   (  ) const [pure virtual] 
Copy code to clipboard
get_db()

   Database* InterSystems::Obj_t::get_db
   (  ) const [inline, inherited] 
Copy code to clipboard
get_ref()

Do not use (reserved for InterSystems internal use).

get_val()

Do not use (reserved for InterSystems internal use).

has_idkey()

   virtual DLL_DECL bool LC_Persistent_t::has_idkey
   (  ) [inline, virtual] 
Copy code to clipboard
id()

   const wchar_t * LC_Persistent_t::id
   (  ) const [inline] 
Copy code to clipboard
   int LC_Persistent_t::id
   (  char * buf, 
      size_t bufsiz 
   ) [inline] 
Copy code to clipboard
   int LC_Persistent_t::id
   (  wchar_t * buf, 
      size_t bufsiz 
   ) [inline] 
Copy code to clipboard
id_is_uni()

   bool LC_Persistent_t::id_is_uni
   (  ) const [inline] 
Copy code to clipboard
insert()

   d_status LC_Persistent_t::insert
   (  bool defer_indices = false, 
      int timeout = -1, 
      Db_err * err = 0 )
Copy code to clipboard
is_attached()

   bool LC_Persistent_t::is_attached
   (  ) [inline] 
Copy code to clipboard
is_connected()

   bool LC_Persistent_t::is_connected
   (  ) [inline] 
Copy code to clipboard
save()

   virtual DLL_DECL d_status LC_Persistent_t::save
   (  bool defer_indices = false, 
      int timeout = -1, 
      Db_err * err = 0 
   ) [pure virtual] 
Copy code to clipboard
serialize()

   virtual DLL_DECL void LC_Persistent_t::serialize
   (  lc_dlist_out * , 
      LC_Database * 
   ) [inline, virtual] 
Copy code to clipboard
serialize_idkey()

   virtual DLL_DECL void LC_Persistent_t::serialize_idkey
   (  lc_dlist_out * , 
      LC_Database * 
   ) [inline, virtual] 
Copy code to clipboard
set_id_from_properties()

   virtual DLL_DECL void LC_Persistent_t::set_id_from_properties
   (  ) [inline, virtual] 
Copy code to clipboard
to_xml()

Do not use (reserved for InterSystems internal use).

unlock()

   virtual void LC_Persistent_t::unlock
   (  ) [pure virtual] 
Copy code to clipboard
update()

   d_status LC_Persistent_t::update
   (  bool defer_indices = false, 
      int timeout = -1, 
      Db_err * err = 0 )
Copy code to clipboard

Class InterSystems::LC_Serial_t

This is the base class used to generate serial classes for the Light C++ Binding. This class can only be used in Light C++ Binding applications.

Constructor

LC_Serial_t()

Constructor is a PROTECTED member function (see Standard Proxy Class Methods).

   InterSystems::LC_Serial_t::LC_Serial_t
   ( ) [inline, protected] 
Copy code to clipboard

Member list

dirty()

   bool LC_Serial_t::dirty 
   (  ) const [inline]
Copy code to clipboard
getProperties()

   virtual void  LC_Serial_t::getProperties
   (  lc_dlist_in &in,
      bool unicode_srv
   )=0 [pure virtual]
Copy code to clipboard
serialize()

   virtual void LC_Serial_t::serialize
   (  lc_dlist_out *outlist,
      LC_Database *db
   )=0 [pure virtual]
Copy code to clipboard
set_clean()

   void LC_Serial_t::set_clean
   (  ) [inline]
Copy code to clipboard
set_dirty()

   void LC_Serial_t::set_dirty
   (  ) [inline]
Copy code to clipboard

Database Classes

The following database classes are available:

InterSystems::Database Class

This is the database class used by the standard Caché C++ binding.

Constructor

Database()

   Database::Database
   (  const d_connection &  conn,
      bool use_cache = true,
      bool is_lc_db = false )
Copy code to clipboard

Member list

del_obj()

   void InterSystems::Database::del_obj
   (  const d_binary & oid,
      int concurrency
   ) [inline]
Copy code to clipboard
get_class_global_info()

   t_istream & Database::get_class_global_info
   (  const_name_t cl_name,   // const_name_t is a typedef for const wchar_t*
      cl_meta_info_kind info_kind )
Copy code to clipboard
get_class_info()

   t_istream & Database::get_class_info
   (  const_name_t cl_name,   // const_name_t is a typedef for const wchar_t*
      cl_meta_info_kind info_kind )
Copy code to clipboard
get_classes_info()

   t_istream & Database::get_classes_info
   (  const char * msg,
      const std::vector&lt; std::wstring > & cl_names )
Copy code to clipboard
get_coln_property()

   void Database::get_coln_property
   (  int oref,
      const_name_t prop_name,   // const_name_t is a typedef for const wchar_t*
      int ii,
      int idx,
      d_double & res )
Copy code to clipboard
   void Database::get_coln_property
   (  int oref,
      const_name_t prop_name,
      int ii,
      int idx,
      d_int & res )
Copy code to clipboard
   void Database::get_coln_property
   (  int oref,
      const_name_t prop_name,
      int ii,
      int idx,
      d_string & val )
Copy code to clipboard
get_conn()

   d_connection InterSystems::Database::get_conn
   ( ) [inline]
Copy code to clipboard
get_hdbc()

   HDBC InterSystems::Database::get_hdbc
   ( ) [inline]
Copy code to clipboard
get_indexes_info()

   t_istream & Database::get_indexes_info
   (  const_name_t cl_name,   // const_name_t is a typedef for const wchar_t*
      cl_meta_info_kind info_kind )
Copy code to clipboard
get_job_id()

   int InterSystems::Database::get_job_id
   ( ) [inline]
Copy code to clipboard
get_lc_class_info()

   t_istream & Database::get_lc_class_info
   (  const_name_t cl_name,   // const_name_t is a typedef for const wchar_t*
      cl_meta_info_kind info_kind )
Copy code to clipboard
get_methods()

   t_istream & Database::get_methods
   (  const_name_t class_name )   // const_name_t is a typedef for const wchar_t*
Copy code to clipboard
get_nsp()

   const d_string& InterSystems::Database::get_nsp
   ( ) const [inline]
Copy code to clipboard
get_oid()

   d_oid Database::get_oid
   (  int oref )
Copy code to clipboard
get_properties()

   t_istream & Database::get_properties
   (  const_name_t class_name )   // const_name_t is a typedef for const wchar_t*
Copy code to clipboard
get_property()

   t_istream & Database::get_property
   (  int oref,
      int ii,
      int jj,
      d_type_id type_id,
      const_name_t name )   // const_name_t is a typedef for const wchar_t*
Copy code to clipboard
   void Database::get_property
   (  int oref,
      const_name_t prop_name,
      int ii,
      int jj,
      Args_mgr & args_mgr )
Copy code to clipboard
get_proxies_info()

   Proxies_info* InterSystems::Database::get_proxies_info
   ( ) [inline]
Copy code to clipboard
get_queries()

   t_istream & Database::get_queries
   (  const_name_t class_name )   // const_name_t is a typedef for const wchar_t*
Copy code to clipboard
get_query_info()

   t_istream & Database::get_query_info
   (  const wchar_t * class_name,
      const wchar_t * query_name )
Copy code to clipboard
get_run_mtd_level()

   int InterSystems::Database::get_run_mtd_level
   ( ) const [inline]
Copy code to clipboard
get_serialization_info()

   t_istream & Database::get_serialization_info
   (  const_name_t cl_name,   // const_name_t is a typedef for const wchar_t*
      cl_meta_info_kind info_kind )
Copy code to clipboard
get_srv_ver()

   double InterSystems::Database::get_srv_ver
   ( ) const [inline]
Copy code to clipboard
get_status_info()

   void Database::get_status_info
   (  const d_status & status,
      d_int & code,
      d_string & msg,
      const char * lang = "",
      Db_err * err = 0 )
Copy code to clipboard
get_term_input_callback()

   db_input_callback* InterSystems::Database::get_term_input_callback
   ( ) [inline]
Copy code to clipboard
get_term_output()

   db_output& InterSystems::Database::get_term_output
   ( ) [inline]
Copy code to clipboard
init_coln()

   template<typename C>
   void InterSystems::Database::init_coln
   (  int oref,
      C & coln
   ) [inline]
Copy code to clipboard
make_obj()

   t_istream & Database::make_obj
   (  const_name_t type_name,      // const_name_t is a typedef for const wchar_t*
      const_str_t init_val = 0,    // const_str_t is a typedef of const wchar_t*
      Db_err * err = 0 )
Copy code to clipboard
open_cl_def()

   const Class_def* InterSystems::Database::open_cl_def
   (  const_name_t class_name,   // const_name_t is a typedef for const wchar_t*
      bool check_exists = false
   ) [inline]
Copy code to clipboard
openid_obj()

   t_istream & Database::open_obj
   (  const d_binary & oid,
      int concurrency = -1,
      int timeout = -1,
      Db_err * err = 0 )
Copy code to clipboard
   t_istream & Database::openid_obj
   (  const_name_t name,      // const_name_t is a typedef for const wchar_t*
      const_str_t id,         // const_str_t is a typedef of const wchar_t*
      int concurrency = -1,
      int timeout = -1,
      Db_err * err = 0 )
Copy code to clipboard
reset_term_input_callback()

   void InterSystems::Database::reset_term_input_callback
   ( ) [inline]
Copy code to clipboard
reset_term_output_callback()

   void InterSystems::Database::reset_term_output_callback
   ( ) [inline]
Copy code to clipboard
run_method()

   t_istream & Database::run_method
   (  int obj_ref,
      const_name_t cl_name,   // const_name_t is a typedef for const wchar_t*
      const_name_t mtd_name,
      D_type ** args,
      int num_args,
      const int * refs,
      int num_refs,
      d_type_id ret_t )
Copy code to clipboard
   void Database::run_method
   (  int oref,
      const_name_t cl_name,
      const_name_t mtd_name,
      Args_mgr & args_mgr )
Copy code to clipboard
set_property()

   void Database::set_property
   (  int oref,
      const_name_t prop_name,   // const_name_t is a typedef for const wchar_t*
      int ii,
      int jj,
      int mod_flag,
      Args_mgr & args_mgr )
Copy code to clipboard
   void Database::set_property
   (  int oref,
      int ii,
      int jj,
      int mod_flag,
      const_name_t name,   // const_name_t is a typedef for const wchar_t*
      D_type * val )
Copy code to clipboard
set_term_input_callback()

   void InterSystems::Database::set_term_input_callback
   (  db_input_callback * f ) [inline]
Copy code to clipboard
set_term_output_callback()

   void InterSystems::Database::set_term_output_callback
   (  db_output_callback * f ) [inline]
Copy code to clipboard
sync()

   void Database::sync ( )
Copy code to clipboard
tcommit()

See Using Transactions for an example.

   void InterSystems::Database::tcommit
   (  Db_err * err = 0 ) [inline]
Copy code to clipboard
tlevel()

See Using Transactions for an example.

   int InterSystems::Database::tlevel
   (  Db_err * err = 0 ) [inline]
Copy code to clipboard
trollback()

See Using Transactions for an example.

   void InterSystems::Database::trollback
   (  Db_err * err = 0 ) [inline]
Copy code to clipboard
tstart()

See Using Transactions for an example.

   void InterSystems::Database::tstart
   (  Db_err * err = 0 ) [inline]
Copy code to clipboard
unicode_srv()

   bool InterSystems::Database::unicode_srv
   ( ) const [inline]
Copy code to clipboard

InterSystems::LC_Database Class

This is the database class used by the Light C++ Binding. This class can only be used in Light C++ Binding applications.

Constructor

LC_Database()

   InterSystems::LC_Database::LC_Database
   (  const d_connection & conn,
      bool use_cache = true
   ) [inline] 
Copy code to clipboard

Member list

add_key_prop()

Do not use (reserved for InterSystems internal use).

build_indexes()

   void LC_Database::build_indexes
   (  const unsigned char * classname,
      int classname_length )
Copy code to clipboard
check_thread()

Do not use (reserved for InterSystems internal use).

create_index_entry()

Do not use (reserved for InterSystems internal use).

cvtForCollation()

Do not use (reserved for InterSystems internal use).

del_obj()

Do not use (reserved for InterSystems internal use).

delete_direct()

Do not use (reserved for InterSystems internal use).

delete_index_entry()

Do not use (reserved for InterSystems internal use).

delete_object()

Do not use (reserved for InterSystems internal use).

get_coln_property()

Do not use (reserved for InterSystems internal use).

get_conn()

   d_connection InterSystems::Database::get_conn
   ( ) [inline, inherited]
Copy code to clipboard
get_default_concurrency_level()

   int InterSystems::LC_Database::get_default_concurrency_level
   ( ) [inline]
Copy code to clipboard
get_default_max_locks()

   int InterSystems::LC_Database::get_default_max_locks
   ( ) [inline]
Copy code to clipboard
get_default_timeout()

   int InterSystems::LC_Database::get_default_timeout
   ( ) [inline]
Copy code to clipboard
get_hdbc()

Do not use (reserved for InterSystems internal use).

get_idkey_out_list()

Do not use (reserved for InterSystems internal use).

get_in_list()

Do not use (reserved for InterSystems internal use).

get_indexes_info()

Do not use (reserved for InterSystems internal use).

get_job_id()

Do not use (reserved for InterSystems internal use).

get_lc_class_info()

Do not use (reserved for InterSystems internal use).

get_methods()

Do not use (reserved for InterSystems internal use).

get_nsp()

Do not use (reserved for InterSystems internal use).

get_oid()

Do not use (reserved for InterSystems internal use).

get_out_list()

Do not use (reserved for InterSystems internal use).

get_properties()

Do not use (reserved for InterSystems internal use).

get_property()

Do not use (reserved for InterSystems internal use).

get_proxies_info()

Do not use (reserved for InterSystems internal use).

get_queries()

Do not use (reserved for InterSystems internal use).

get_query_info()

Do not use (reserved for InterSystems internal use).

get_run_mtd_level()

Do not use (reserved for InterSystems internal use).

get_serialization_info()

Do not use (reserved for InterSystems internal use).

get_srv_info()

Do not use (reserved for InterSystems internal use).

get_srv_ver()

Do not use (reserved for InterSystems internal use).

get_status_info()

Do not use (reserved for InterSystems internal use).

get_term_input_callback()

Do not use (reserved for InterSystems internal use).

get_term_output()

Do not use (reserved for InterSystems internal use).

init_coln()

Do not use (reserved for InterSystems internal use).

lc_batch_save()

   void LC_Database::lc_batch_save
   (  int num_objs,
      lc_nested_list_iterator & buf,
      std::vector&lt; std::pair&lt; d_status, d_binary > > & errors,
      std::vector&lt; d_string > & ids,
      const unsigned char * classname,
      int classname_length,
      int concurrency = -1,
      bool use_idkeys = false,
      bool return_ids = false,
      byte_size_t cap = 0,
      bool do_tx = true )
Copy code to clipboard
lc_openid_obj()

Do not use (reserved for InterSystems internal use).

make_obj()

Do not use (reserved for InterSystems internal use).

open_cl_def()

Do not use (reserved for InterSystems internal use).

open_obj()

Do not use (reserved for InterSystems internal use).

openid_obj()

Do not use (reserved for InterSystems internal use).

reset()

Do not use (reserved for InterSystems internal use).

reset_idkey_props()

Do not use (reserved for InterSystems internal use).

reset_term_input_callback()

Do not use (reserved for InterSystems internal use).

reset_term_output_callback()

Do not use (reserved for InterSystems internal use).

run_method()

Do not use (reserved for InterSystems internal use).

save()

Do not use (reserved for InterSystems internal use).

save_direct()

Do not confuse this with the direct_save() method used by Light C++ Binding projection classes (see Standard LCB Object Methods).

Do not use (reserved for InterSystems internal use).

set_key_props_id()

Do not use (reserved for InterSystems internal use).

set_key_props_index()

Do not use (reserved for InterSystems internal use).

set_lcb_option ()

Do not use (reserved for InterSystems internal use).

set_property()

Do not use (reserved for InterSystems internal use).

set_term_input_callback()

Do not use (reserved for InterSystems internal use).

set_term_output_callback()

Do not use (reserved for InterSystems internal use).

sync()

Do not use (reserved for InterSystems internal use).

tcommit()

See Using Transactions for an example.

   void InterSystems::Database::tcommit
   (  Db_err * err = 0) [inline, inherited]
Copy code to clipboard
time_to_string()

   void LC_Database::time_to_string
   (  d_time & in,
      d_string & out )
Copy code to clipboard
timestamp_to_string()

   void LC_Database::timestamp_to_string
   (  d_timestamp & in,
      d_string & out )
Copy code to clipboard
tlevel()

See Using Transactions for an example.

   int InterSystems::Database::tlevel
   (  Db_err * err = 0) [inline, inherited]
Copy code to clipboard
transaction()

See Using Transactions for an example.

   void LC_Database::transaction
   (  trans_flag_t flag,
      Db_err * err,
      int * level = 0
   ) [virtual]
Copy code to clipboard
trollback()

See Using Transactions for an example.

   void InterSystems::Database::trollback
   (  Db_err * err = 0) [inline, inherited]
Copy code to clipboard
tstart()

See Using Transactions for an example.

   void InterSystems::Database::tstart
   (  Db_err * err = 0) [inline, inherited]
Copy code to clipboard
unicode_srv()

   bool InterSystems::Database::unicode_srv
   ( ) const [inline, inherited]
Copy code to clipboard
unlock()

Do not use (reserved for InterSystems internal use).

unlock_after_delete()

Do not use (reserved for InterSystems internal use).

Connection Classes

The following connection classes are available:

Class d_connection

d_connection is a proxy class that acts as a smart pointer to a Conn_t class instance. See Connecting to the Caché Database for more information.

Class InterSystems::Conn_t

This is the base connection class. Always use d_connection rather than accessing this class directly.

Constructor

Conn_t()

   InterSystems::Conn_t::Conn_t ( ) [inline]
Copy code to clipboard

Member list

alloc_messenger()

   virtual int InterSystems::Conn_t::alloc_messenger
   (  void ** ppm) [inline, virtual] 
Copy code to clipboard
free_messenger()

   virtual int InterSystems::Conn_t::free_messenger
   (  void * pm) [inline, virtual] 
Copy code to clipboard
get_thread_check()

   virtual LC_Thread_Check* InterSystems::Conn_t::get_thread_check
   ( ) const [inline, virtual] 
Copy code to clipboard
is_busy()

   bool InterSystems::Conn_t::is_busy
   ( ) const [inline] 
Copy code to clipboard
is_connected()

   bool InterSystems::Conn_t::is_connected
   ( ) const [inline] 
Copy code to clipboard
is_uni_srv()

   bool InterSystems::is_uni_srv_info::is_uni_srv
   ( ) const [inline, inherited] 
Copy code to clipboard
lock()

   void InterSystems::Conn_t::lock
   ( ) [inline] 
Copy code to clipboard
release_to_pool()

   virtual void InterSystems::Conn_t::release_to_pool
   ( ) [inline, virtual] 
Copy code to clipboard
set_uni_srv()

   void InterSystems::is_uni_srv_info::set_uni_srv
   (  bool val) [inline, inherited] 
Copy code to clipboard
unlock()

   void InterSystems::Conn_t::unlock
   ( ) [inline] 
Copy code to clipboard

Class InterSystems::tcp_conn

This is the connection class for the standard C++ binding. It inherits from Conn_t and uses TCP/IP to implement the connection.

Constructor

tcp_conn()

   InterSystems::tcp_conn::tcp_conn ( ) [inline] 
Copy code to clipboard

Member list

alloc_messenger()

   int tcp_conn::alloc_messenger
   (  void ** ppm) [virtual] 
Copy code to clipboard
connect()

   d_connection tcp_conn::connect
   (  const d_string & conn_str, 
      const d_string & srv_principal_name, 
      int security_level, 
      int timeout = 0, 
      Db_err * err = 0 
   ) [static] 
Copy code to clipboard
   d_connection tcp_conn::connect
   (  const d_string & conn_str, 
      const d_string & user, 
      const d_string & pwd, 
      int timeout = 0, 
      Db_err * err = 0 
   ) [static] 
Copy code to clipboard
free_messenger()

   int tcp_conn::free_messenger
   (  void * pm) [virtual] 
Copy code to clipboard
get_connection()

   d_connection tcp_conn::get_connection
   (  const d_string & conn_str, 
      const d_string & user, 
      const d_string & pwd, 
      int timeout = 0, 
      Db_err * err = 0 
   ) [static] 
Copy code to clipboard
get_namespaces()

   void tcp_conn::get_namespaces
   (  const wchar_t * host, 
      const wchar_t * port, 
      const wchar_t * srv_principal_name, 
      int security_level, 
      int timeout, 
      std::list&lt; std::wstring > & res, 
      Conn_err * err = 0 
   ) [static] 
Copy code to clipboard
   void tcp_conn::get_namespaces
   (  const wchar_t * host, 
      const wchar_t * port, 
      const wchar_t * user, 
      const wchar_t * pwd, 
      int timeout, 
      std::list&lt; std::wstring > & res, 
      Conn_err * err = 0 
   ) [static] 
Copy code to clipboard
get_thread_check()

   LC_Thread_Check* InterSystems::tcp_conn::get_thread_check
   ( ) const [inline, virtual] 
Copy code to clipboard
is_busy()

   bool InterSystems::Conn_t::is_busy
   ( ) const [inline, inherited] 
Copy code to clipboard
is_connected()

   bool InterSystems::Conn_t::is_connected
   ( ) const [inline, inherited] 
Copy code to clipboard
is_uni_srv()

   bool InterSystems::is_uni_srv_info::is_uni_srv
   ( ) const [inline, inherited] 
Copy code to clipboard
lock()

   void InterSystems::Conn_t::lock
   ( ) [inline, inherited] 
Copy code to clipboard
parse_conn_str()

   void Conn_t::parse_conn_str
   (  const std::wstring & conn_str, 
      std::wstring * host, 
      std::wstring * port, 
      std::wstring * nsp 
   ) [static, protected, inherited] 
Copy code to clipboard
set_uni_srv()

   void InterSystems::is_uni_srv_info::set_uni_srv
   (  bool val) [inline, inherited] 
Copy code to clipboard
unlock()

   void InterSystems::Conn_t::unlock
   ( ) [inline, inherited] 
Copy code to clipboard

Class InterSystems::lc_conn

This is the connection class for the Light C++ Binding. It inherits from Conn_t and uses intraprocess communications to implement the connection. This class can only be used in Light C++ Binding applications.

Constructor

lc_conn()

   lc_conn::lc_conn ( ) [inline]
Copy code to clipboard

Member list

alloc_messenger()

Do not use (reserved for InterSystems internal use).

connect()

   static d_connection lc_conn::connect
   (  const d_string & conn_str, 
      const d_string & user, 
      const d_string & pwd, 
      int timeout = 0, 
      Db_err * err = 0 
   ) [inline, static] 
Copy code to clipboard
disconnect()

   void lc_conn::disconnect
   ( ) [virtual] 
Copy code to clipboard
free_messenger()

Do not use (reserved for InterSystems internal use).

get_thread_check()

Do not use (reserved for InterSystems internal use).

is_busy()

Do not use (reserved for InterSystems internal use).

is_connected()

Do not use (reserved for InterSystems internal use).

is_uni_srv()

   bool InterSystems::is_uni_srv_info::is_uni_srv
   ( ) const [inline, inherited] 
Copy code to clipboard
lock()

Do not use (reserved for InterSystems internal use).

release_to_pool()

Do not use (reserved for InterSystems internal use).

set_uni_srv()

Do not use (reserved for InterSystems internal use).

unlock()

Do not use (reserved for InterSystems internal use).

Object Reference Classes

The following classes are available:

Class Template InterSystems::d_ref<T>

See Generating Proxy Classes and Using Proxy Objects for more information about this class.

Constructor

d_ref()

   template<class T>
   InterSystems::d_ref< T >::d_ref
   ( ) [inline] 
Copy code to clipboard
   template<class T>
   InterSystems::d_ref< T >::d_ref
   (  T * p) [inline] 
Copy code to clipboard
   template<class T>
   InterSystems::d_ref< T >::d_ref
   (  bool dummy, 
      T * p 
   ) [inline] 
Copy code to clipboard
   template<class T>
   InterSystems::d_ref< T >::d_ref
   (  T * p, 
      int * ref_cnt 
   ) [inline] 
Copy code to clipboard
   template<class T>
   InterSystems::d_ref< T >::d_ref
   (  bool dummy, 
      T * p, 
      int * ref_cnt 
   ) [inline] 
Copy code to clipboard
   template<class T>
   template<typename P>
   InterSystems::d_ref< T >::d_ref
   (  const d_ref< P > & p) [inline] 
Copy code to clipboard
   template<class T>
   InterSystems::d_ref< T >::d_ref
   (  const d_ref< T > & r) [inline] 
Copy code to clipboard

Member list

conv_to()

   template<class T> 
   template<typename P> 
   void InterSystems::d_ref< T >::conv_to
   (  d_ref< P > & res) [inline] 
Copy code to clipboard
get()

   template<typename T> 
   void InterSystems::d_ref< T >::get
   (  t_istream & in, Database * db) [virtual] 
Copy code to clipboard
   void D_type::get
   (  char * buf, 
      byte_size_t size, 
      Database * db = 0 
   ) [inherited] 
Copy code to clipboard
get_conv_ptr()

   template<class T> 
   const T* InterSystems::d_ref< T >::get_conv_ptr
   ( ) const [inline] 
Copy code to clipboard
get_cpp_type()

   static SQLSMALLINT InterSystems::abs_d_ref::get_cpp_type
   ( ) [inline, static, inherited] 
Copy code to clipboard
get_data()

   void D_type::get_data
   (  d_seq_query & query) [virtual, inherited] 
Copy code to clipboard
get_ignore_null()

   static bool InterSystems::D_type::get_ignore_null
   ( ) [inline, static, inherited] 
Copy code to clipboard
get_is_lc_dref()

   bool InterSystems::abs_d_ref::get_is_lc_dref
   ( ) const [inline, inherited] 
Copy code to clipboard
get_oref_n_name()

   void abs_d_ref::get_oref_n_name
   (  t_istream & in, 
      int * oref, 
      cl_name_t name 
   ) [static, inherited] 
Copy code to clipboard
get_type_id()

   d_type_id InterSystems::abs_d_ref::get_type_id
   ( ) const [inline, virtual, inherited] 
Copy code to clipboard
is_null()

   bool InterSystems::D_type::is_null
   ( ) const [inline, inherited] 
Copy code to clipboard
is_obj()

   bool InterSystems::D_type::is_obj
   ( ) const [inline, inherited] 
Copy code to clipboard
make_not_null()

   void InterSystems::D_type::make_not_null
   ( ) [inline, inherited] 
Copy code to clipboard
make_null()

   void InterSystems::abs_d_ref::make_null
   ( ) [inline, virtual, inherited] 
Copy code to clipboard
make_undef()

   void InterSystems::D_type::make_undef
   ( ) [inline, inherited] 
Copy code to clipboard
operator !=

   bool InterSystems::abs_d_ref::operator!=
   (  const abs_d_ref & r) const [inline, inherited] 
Copy code to clipboard
operator ->

   template<class T> 
   T* InterSystems::d_ref< T >::operator->
   ( ) const [inline] 
Copy code to clipboard
operator =

   template<class T> 
   template<typename P> 
   d_ref& InterSystems::d_ref< T >::operator=
   (  const d_ref< P > & p) [inline] 
Copy code to clipboard
operator ==

   bool InterSystems::abs_d_ref::operator==
   (  const abs_d_ref & r) const [inline, inherited] 
Copy code to clipboard
operator *

   template<class T> 
   T& InterSystems::d_ref< T >::operator *
   ( ) const [inline] 
Copy code to clipboard
operator <<

   std::ostream& operator <<
   (  std::ostream & out, 
      const abs_d_ref & r 
   ) [friend, inherited] 
Copy code to clipboard
put()

   byte_size_t D_type::put
   ( char * buf, 
   byte_size_t cap, 
   bool uni_srv, 
   Database * db = 0 
   ) [inherited] 
Copy code to clipboard
   void InterSystems::abs_d_ref::put
   (  t_ostream & out, 
      Database * db = 0 
   ) const [inline, virtual, inherited] 
Copy code to clipboard
put_empty()

   void InterSystems::D_type::put_empty
   (  t_ostream & out) const [inline, inherited] 
Copy code to clipboard
put_null()

   void InterSystems::D_type::put_null
   (  t_ostream & out) const [inline, inherited] 
Copy code to clipboard
set_ignore_null()

   static void InterSystems::D_type::set_ignore_null
   (  bool val) [inline, static, inherited] 
Copy code to clipboard
set_par()

   void D_type::set_par
   (  abs_d_query & query, 
      int idx 
   ) const [virtual, inherited] 
Copy code to clipboard
to_xml()

   void abs_d_ref::to_xml
   (  xml_writer & out) const [virtual, inherited] 
Copy code to clipboard
to_xml_null_value()

   void InterSystems::D_type::to_xml_null_value
   (  xml_writer & out) const [inline, inherited] 
Copy code to clipboard

Class Template InterSystems::lc_d_ref<T>

This is the reference class template used by the Light C++ Binding. The information on d_ref in Generating Proxy Classes and Using Proxy Objects also applies to this class. This class can only be used in Light C++ Binding applications.

Constructor

lc_d_ref()

   template<class T>
   lc_d_ref< T >::lc_d_ref
   ( ) [inline]
Copy code to clipboard
   template<class T>
   lc_d_ref< T >::lc_d_ref
   ( T * p ) [inline]
Copy code to clipboard
   template<class T>
   lc_d_ref< T >::lc_d_ref
   (  T *  p,
      int *  ref_cnt 
   ) [inline]
Copy code to clipboard

Member list

(This class has no public member functions).