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

Main Page   Compound List   Compound Members  

ISoamConnection Interface Reference

Used by the client to maintain a physical connection between client and the SOA middleware for an application. More...

List of all members.


Public Methods

HRESULT CreateSession ([in] ISoamSessionCreationAttributes *attributes,[out, retval] ISoamSession **session)
 Creates a ISoamSession on a connection.

HRESULT OpenSession ([in] ISoamSessionOpenAttributes *attributes,[out, retval] ISoamSession **session)
 Opens an existing session.

HRESULT Close ()
 Close the connection.

HRESULT Id ([out, retval] BSTR *pVal)
 Get the ID of this Connection. The Connection's ID will have a unique value.


Detailed Description

Used by the client to maintain a physical connection between client and the SOA middleware for an application.

This interface can be thought of as representing the actual connection to an SSM through which it will communicate with the services of an application. The connection object could be created by using ISoamAPI->connect, on which a session object could be created by using Connection::createSession to manage the workload.

See also:
ISoamAPI , ISoamSession


Member Function Documentation

HRESULT CreateSession [in] ISoamSessionCreationAttributes   attributes,
[out, retval] ISoamSession **    session
 

Creates a ISoamSession on a connection.

Creates a session on a connection with the given attributes.

Parameters:
attributes  [IN] - The attributes to apply to the session upon creation.
attributes  [OUT, RETVAL] - ISoamSession
Note:
For "Recoverable Sessions" (as specified by the "recoverable" flag being given a value of "true" in the Application Profile), all submissions will wait for a special confirmation from the middleware that the input has been stored in a manner that it can be recovered. This means that the time for input submission of all "Recoverable Sessions" "may" be longer than those of "Non-Recoverable Sessions".
Returns:
a pointer to a ISoamSession.
Exceptions:
ISoamException 
See also:
ISoamAPI->Connect , SessionCreationAttributes

HRESULT OpenSession [in] ISoamSessionOpenAttributes   attributes,
[out, retval] ISoamSession **    session
 

Opens an existing session.

Opens an existing session with the given attributes, and associates it with this connection.

Parameters:
attributes  [IN] - The attributes to apply to the session upon opening.
attributes  [OUT, RETVAL] - ISoamSession
Returns:
a pointer to a ISoamSession.
Note:
Since a session can only be associated with one connection at a time, if the session being opened is already associated with a different connection, the open request will succeed and the session will now be associated with the new connection. The client that had the session opened prior to this new open request will be disconnected from the session and an exception will be returned to that client indicating the transfer of the association.
Exceptions:
ISoamException 
See also:
ISoamAPI->Connect , SessionOpenAttributes

HRESULT Close  
 

Close the connection.

Closing the connection will result in the logical connection between the client and the middleware to become broken. Once a connection is closed, no further operations can be performed on the connection and all open sessions will be aborted by the middleware.

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

Exceptions:
ISoamException 

HRESULT Id [out, retval] BSTR *    pVal
 

Get the ID of this Connection. The Connection's ID will have a unique value.

This method will retrieve the ID associated with the connection. It can be used to re-establish a connection with the application.

Returns:
a Connection ID.
Exceptions:
ISoamException 


     
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.