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

Main Page   Class Hierarchy   Compound List   Compound Members  

SessionUpdateAttributes Class Reference

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

List of all members.


Public Methods

 SessionUpdateAttributes ()
 Default constructor.

virtual ~SessionUpdateAttributes ()
 Destructor.

void setCommonData (Message *commonData) throw (SoamException)
 Sets a common data update.


Friends

class Session

Detailed Description

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

Default values are as follows: common data - This argument allows you do provide common data updates to the session. The common data update will become immediately available to the pending tasks in your session. If you require that the pending tasks for this session are not computed against this common data update, you must first wait for those tasks to complete before sending your update. You can only provide a common data update if you had provided some initial common data when you created the session. Common data is any data that is common to all of the tasks in your session. You can send common data rather than sending duplicate data to each task, and thus save on network overhead. Default value is null - no common data update.

See also:
Session::update


Constructor & Destructor Documentation

SessionUpdateAttributes  
 

Default constructor.

Constructs a SessionUpdateAttributes object with default settings.

virtual ~SessionUpdateAttributes   [virtual]
 

Destructor.


Member Function Documentation

void setCommonData Message   commonData throw (SoamException)
 

Sets a common data update.

This method allows you to set a common data update for the session.

Default value is null - no common data update.

Parameters:
commonData  [IN] - The common data update for the session.
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.