Visit Platform at http://www.platform.com

Main Page   Compound List   Compound Members  

ISoamAPI Interface Reference

Factory class for the client to allocate the soam API objects. More...

List of all members.


Public Methods

HRESULT Initialize ()
 Initializes the API.

HRESULT Uninitialize ()
 Un-initializes the API.

HRESULT Connect ([in] BSTR applicationName,[in] ISoamConnectionSecurityCallback *callback,[out, retval] ISoamConnection **connection)
 Initialize a connection object and start up the connection to SOAM.


Detailed Description

Factory class for the client to allocate the soam API objects.

This factory class is used to allocate the SOAM API objects for the client to provide proper lifetime management for all concrete objects in the SOAM API.

See also:
Connection


Member Function Documentation

HRESULT Initialize  
 

Initializes the API.

The initialize(...) method should be called before any other soam API method is called. This method is mandatory which means all other API calls will fail if this method is ommitted. initialize(...) can be called multiple times without penalty, however, best practices dictate that this should be called only once, since uninitialize(...) can only be called once.

HRESULT Uninitialize  
 

Un-initializes the API.

The uninitialize(...) method should be called at the end of all API calls. It should be called only once. Once uninitialize(...) is called, no other API calls are possible for the life of the process.

** NOTE : Never call uninitialize(...) during the execution of a callback method. This will result in a deadlock.

HRESULT Connect [in] BSTR    applicationName,
[in] ISoamConnectionSecurityCallback   callback,
[out, retval] ISoamConnection **    connection
 

Initialize a connection object and start up the connection to SOAM.

Provide access to a connection object with the given application and correct credentials. Once this connection is acquired you may proceed to interact with the application.

Parameters:
applicationName  [IN] -- The name of the application.
callback  [IN] -- The callback to be used for authentication while the connection is being established.
Returns:
a pointer of a Connection object.
Exceptions:
ISoamException  - if the connection failed
See also:
Connection::createSession , ConnectionSecurityCallback


     
Date Modified: 3 Nov 2008
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2008 Platform Computing Corporation. All rights reserved.