Codemesh Runtime v3 C++ API Reference  3.9.205
Public Types | Public Member Functions | List of all members
xmog_connection_provider Class Reference

The facade for all custom connection providers. More...

#include <xmog_connection_provider.h>

Public Types

typedef int(XMOG_CALLING_CONVENTION * XMOG_CONNECT_METHOD) (xmog_jvm **result, const char *connect, xmog_authentication_provider *auth, xmog_encryption_provider *enc)
 The function prototype for connecting to the server.
 
typedef int(XMOG_CALLING_CONVENTION * XMOG_DISCONNECT_METHOD) (xmog_jvm *)
 The function prototype for disconnecting from the server.
 

Public Member Functions

 xmog_connection_provider (const char *connect, xmog_authentication_provider *auth, xmog_encryption_provider *enc)
 Creates an connection provider instance based on an connection string. More...
 
 ~xmog_connection_provider ()
 
int connect (xmog_jvm **result)
 Attempts to connect to the server using the specified settings. More...
 
int disconnect (xmog_jvm *jvm)
 Attempts to disconnect from the server. More...
 

Detailed Description

The facade for all custom connection providers.

Constructor & Destructor Documentation

◆ xmog_connection_provider()

xmog_connection_provider::xmog_connection_provider ( const char *  connect,
xmog_authentication_provider auth,
xmog_encryption_provider enc 
)

Creates an connection provider instance based on an connection string.

Parameters
connectthe provider-specific connection options.
auththe authentication provider. The connection provider will take ownership of the authentication provider.
encthe encryption provider. The connection provider will take ownership of the encryption provider.

◆ ~xmog_connection_provider()

xmog_connection_provider::~xmog_connection_provider ( )

Cleans up the internal information.

Member Function Documentation

◆ connect()

int xmog_connection_provider::connect ( xmog_jvm **  result)

Attempts to connect to the server using the specified settings.

Parameters
resultthe address of the variable that receives the resulting xmog_jvm pointer.

◆ disconnect()

int xmog_connection_provider::disconnect ( xmog_jvm jvm)

Attempts to disconnect from the server.

Parameters
jvmthe xmog_jvm from which to disconnect.

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

Copyright (c) 1999-2020 by Codemesh, Inc., ALL RIGHTS RESERVED.