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

Main Page   Class Hierarchy   Compound List   Compound Members  

SessionOpenAttributes Class Reference

Container for all attributes that may be required when opening a session. More...

List of all members.


Public Methods

 SessionOpenAttributes ()
 Default constructor.

virtual ~SessionOpenAttributes ()
 Destructor.

void setSessionId (const char *id) throw (SoamException)
 Sets the id of the session to open.

void setSessionFlags (const SoamUInt32 flags) throw (SoamException)
 Sets the session flags.

void setSessionCallback (SessionCallback *callback) throw (SoamException)
 Sets the session callback.


Friends

class Connection

Detailed Description

Container for all attributes that may be required when opening a session.

See also:
Connection::openSession(const SessionOpenAttributes& attributes)


Constructor & Destructor Documentation

SessionOpenAttributes  
 

Default constructor.

Constructs a SessionOpenAttributes object with default settings.

virtual ~SessionOpenAttributes   [virtual]
 

Destructor.


Member Function Documentation

void setSessionId const char *    id throw (SoamException)
 

Sets the id of the session to open.

Parameters:
id  [IN] - The session id.
Exceptions:
SoamException 

void setSessionFlags const SoamUInt32    flags throw (SoamException)
 

Sets the session flags.

The session flags are used to inform the API of any extended behavior to associate with the session. When not specified the default flag will be SF_SYNC. This value can be a combination of Session::SessionFlags values. See samples for details.

Parameters:
flags  [IN] - The session flags.
Exceptions:
SoamException 
See also:
Session::SessionFlags

void setSessionCallback SessionCallback   callback throw (SoamException)
 

Sets the session callback.

This method allows you to specify a SessionCallback object, which is a handler that will allow you to process your session's task results asynchronously. The session callback should only be provided when you have set the appropriate session flags to indicate that you will be receiving task results asynchronously. Default value is null - no session callback.

Parameters:
callback  [IN] - The session callback.
Exceptions:
SoamException 


     
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.