xmog_connection_provider Class Reference

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

#include <xmog_connection_provider.h>

Collaboration diagram for xmog_connection_provider:

[legend]List of all members.

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.
	~xmog_connection_provider ()
int	connect (xmog_jvm **result)
	Attempts to connect to the server using the specified settings.
int	disconnect (xmog_jvm *jvm)
	Attempts to disconnect from the server.

---

Detailed Description

The facade for all custom connection providers.

---

Constructor & Destructor Documentation

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: connect  the provider-specific connection options. auth  the authentication provider. The connection provider will take ownership of the authentication provider. enc  the encryption provider. The connection provider will take ownership of the encryption provider.

xmog_connection_provider::~xmog_connection_provider (   )

Cleans up the internal information.

---

Member Function Documentation

int xmog_connection_provider::connect (  xmog_jvm **  result  )

Attempts to connect to the server using the specified settings. Parameters: result  the address of the variable that receives the resulting xmog_jvm pointer.

int xmog_connection_provider::disconnect (  xmog_jvm *  jvm  )

Attempts to disconnect from the server. Parameters: jvm  the xmog_jvm from which to disconnect.

---

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

• xmog_connection_provider.h

---