A server handle represents a connection between the client application and the Oracle database server.
More...
|
constexpr | Server () noexcept |
|
| Server (const OCI::Environment &environment, void *ociserver, bool ownsHandle) |
| Constructs a new Server object.
|
|
| Server (const Server &other)=delete |
|
constexpr | Server (Server &&other) noexcept |
|
Server & | operator= (const Server &other)=delete |
|
Server & | operator= (Server &&other) noexcept |
|
constexpr void | swap (Server &other) noexcept |
|
const OCI::Environment & | Environment () const |
|
const OCI::ErrorHandle & | Error () const noexcept final override |
| Provides access to the OCIError that will be used for OCI calls for this object.
|
|
HO_EXPORT void | Attach (const wchar_t *databaseLink, size_t databaseLinkLength, ServerAttachMode attachMode=ServerAttachMode::Default) const |
|
template<WideStringLike StringT> |
void | Attach (const StringT &databaseLink, ServerAttachMode attachMode=ServerAttachMode::Default) const |
|
HO_EXPORT void | Detach () const |
|
HO_EXPORT ServiceContext | CreateServiceContext () const |
|
HO_EXPORT ServiceContext | CreateServiceContext (const wchar_t *username, size_t usernameLength, const wchar_t *password, size_t passwordLength, const wchar_t *databaseLink, size_t databaseLinkLength, ServerAttachMode attachMode=ServerAttachMode::Default) const |
|
template<WideStringLike StringT1, WideStringLike StringT2, WideStringLike StringT3> |
ServiceContext | CreateServiceContext (const StringT1 &username, const StringT2 &password, const StringT3 &databaseLink, ServerAttachMode attachMode=ServerAttachMode::Default) const |
|
template<WideStringLike StringT = WideString> |
StringT | ExternalName () const |
| The external name is the user-friendly global name stored in sys.props$.value$, where name = 'GLOBAL_DB_NAME'. It is not guaranteed to be unique unless all databases register their names with a network directory service.
|
|
template<WideStringLike StringT> |
void | SetExternalName (const StringT &externalName) const |
|
OCI::FailoverCallback * | FailoverCallback () const |
|
void | SetFailoverCallback (OCI::FailoverCallback *failoverCallback) const |
|
template<WideStringLike StringT = WideString> |
StringT | InternalName () const |
|
template<WideStringLike StringT> |
void | SetInternalName (const StringT &internalName) const |
|
bool | Oracle8Mode () const |
|
bool | NonBlocingMode () const |
|
void | SetNonBlocingMode (bool nonBlocingMode) const |
|
template<WideStringLike StringT = WideString> |
StringT | ServerGroup () const |
| An alpha-numeric string not exceeding 30 characters specifying the server group.
|
|
template<WideStringLike StringT> |
void | SetServerGroup (const StringT &serverGroup) const |
| An alpha-numeric string not exceeding 30 characters specifying the server group.
|
|
UInt32 | ServerStatus () const |
| Returns the current status of the server handle. Values are: 1 - There is an active connection to the server. It means that the last call on the connection went through.There is no guarantee that the next call will go through. 0 - There is no connection to the server.
|
|
bool | Connected () const |
| Returns true if there is an active connection to the server.
|
|
template<WideStringLike StringT = WideString> |
StringT | DbDomain () const |
|
template<WideStringLike StringT = WideString> |
StringT | DbName () const |
|
template<WideStringLike StringT = WideString> |
StringT | InstanceName () const |
|
DateTime | InstanceStartTime () const |
|
template<WideStringLike StringT = WideString> |
StringT | ServiceName () const |
|
Public Member Functions inherited from Harlinn::OCI::HandleBase |
constexpr void * | Handle () const noexcept |
| Provides access to the value of the handle object.
|
|
constexpr | operator bool () const noexcept |
| Test if the handle value is assigned.
|
|
constexpr bool | IsValid () const noexcept |
| Test if the handle value is assigned.
|
|
constexpr OCI::HandleType | HandleType () const noexcept |
| Returns a value identifying the type of the wrapped handle object.
|
|
|
Protected Member Functions inherited from Harlinn::OCI::HandleBase |
constexpr | HandleBase () noexcept |
| Default constructor.
|
|
constexpr | HandleBase (OCI::HandleType handleType, void *handle, bool ownsHandle) noexcept |
| Constructs a new HandleBase object.
|
|
| HandleBase (const HandleBase &other)=delete |
|
constexpr | HandleBase (HandleBase &&other) noexcept |
| Move constructor.
|
|
virtual | ~HandleBase () |
| Destructor.
|
|
constexpr void | SetHandle (void *newHandleValue, bool ownsHandle) noexcept |
| Assigns the handle value and ownership to this object.
|
|
constexpr bool | OwnsHandle () const noexcept |
| Returns true if this object is the owner of the handle value.
|
|
void * | DetachHandle () |
| If this object is the owner of a handle this function rescinds that ownership, and returns the handle value without closing the handle.
|
|
void | DestroyHandle () |
| Destroys the handle if it is owned by this object.
|
|
HandleBase & | operator= (const HandleBase &other)=delete |
|
constexpr HandleBase & | operator= (HandleBase &&other) noexcept |
|
constexpr void | swap (HandleBase &other) noexcept |
|
template<typename Derived > |
constexpr void | Take (Derived &&derived) noexcept |
| Template function used to implement move assignement in derived classes.
|
|
void | InitializeHandle (void *handle, bool ownsHandle) |
| Provides a "safe" mechanism for assigning a handle value. This functions throws if a handle value is already assigned to this object.
|
|
HO_EXPORT Int32 | GetAttribute (void *buffer, UInt32 *size, Attribute attribute) const |
| Gets the value of an attribute from the handle.
|
|
HO_EXPORT Int32 | SetAttribute (void *buffer, UInt32 size, Attribute attribute) const |
| Sets the value of an attribute on the handle.
|
|
DateTime | GetDateTimeAttribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as a DateTime.
|
|
void | SetDateTimeAttribute (Attribute attribute, const DateTime &value) const |
| Sets the value of an attribute on the handle as a DateTime.
|
|
template<WideStringLike StringT = WideString> |
StringT | GetStringAttribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as a WideString.
|
|
template<WideStringLike StringT = WideString> |
StringT | GetStringAttributeFromByteString (Attribute attribute) const |
| Gets the value of an attribute from the handle as a WideString For use with attributes that are not returned as UTF-16.
|
|
template<WideStringLike StringT> |
void | SetStringAttribute (Attribute attribute, const StringT &value) const |
| Sets the value of an attribute on the handle as a WideString.
|
|
void | SetStringAttribute (Attribute attribute, const wchar_t *value, size_t valueLength) const |
|
bool | GetBooleanAttribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as a bool.
|
|
void | SetBooleanAttribute (Attribute attribute, bool value) const |
| Sets the value of an attribute on the handle as a bool.
|
|
Byte | GetByteAttribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as a Byte.
|
|
void | SetByteAttribute (Attribute attribute, Byte value) const |
| Sets the value of an attribute on the handle as a Byte.
|
|
SByte | GetSByteAttribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as a SByte.
|
|
void | SetSByteAttribute (Attribute attribute, SByte value) const |
| Sets the value of an attribute on the handle as a Byte.
|
|
Int16 | GetInt16Attribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as an Int16.
|
|
void | SetInt16Attribute (Attribute attribute, Int16 value) const |
| Sets the value of an attribute on the handle as an Int16.
|
|
UInt16 | GetUInt16Attribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as an UInt16.
|
|
void | SetUInt16Attribute (Attribute attribute, UInt16 value) const |
| Sets the value of an attribute on the handle as an UInt16.
|
|
Int32 | GetInt32Attribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as an Int32.
|
|
void | SetInt32Attribute (Attribute attribute, Int32 value) const |
| Sets the value of an attribute on the handle as an Int32.
|
|
UInt32 | GetUInt32Attribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as an UInt32.
|
|
void | SetUInt32Attribute (Attribute attribute, UInt32 value) const |
| Sets the value of an attribute on the handle as an UInt32.
|
|
Int64 | GetInt64Attribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as an Int64.
|
|
void | SetInt64Attribute (Attribute attribute, Int64 value) const |
| Sets the value of an attribute on the handle as an Int64.
|
|
UInt64 | GetUInt64Attribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as an UInt64.
|
|
void | SetUInt64Attribute (Attribute attribute, UInt64 value) const |
| Sets the value of an attribute on the handle as an UInt64.
|
|
void * | GetPointerAttribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as a pointer.
|
|
void | SetPointerAttribute (Attribute attribute, void *value) const |
| Sets the value of an attribute on the handle as a pointer.
|
|
OCI::Number * | GetNumberAttribute (Attribute attribute) const |
| Gets the value of an attribute from the handle as a pointer to an OCI::Number.
|
|
Static Protected Member Functions inherited from Harlinn::OCI::HandleBase |
static HO_EXPORT void | HandleFree (void *handle, OCI::HandleType handleType) noexcept |
| Calls OCIHandleFree to release the handle.
|
|
A server handle represents a connection between the client application and the Oracle database server.