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

Main Page   Compound List   Compound Members  

ISoamSessionCreationAttributes Interface Reference

Container for all attributes that may be required upon session creation. More...

List of all members.


Public Methods

HRESULT CommonData ([in] ISoamMessage *newVal)
 Sets the common data.

HRESULT SessionTag ([in] BSTR newVal)
 Sets the session tag.

HRESULT SessionFlags ([in] LONG newVal)
 Sets the session flags.

HRESULT SessionType ([in] BSTR newVal)
 Sets the session type.

HRESULT SessionName ([in] BSTR newVal)
 Sets the session type.


Detailed Description

Container for all attributes that may be required upon session creation.

See also:
ISoamConnection::createSession(const SessionCreationAttributes& attributes)


Member Function Documentation

HRESULT CommonData [in] ISoamMessage   newVal
 

Sets the common data.

This method allows you to provide common data to the created 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 with each task, and thus save on network overhead. Default value is null - no common data.

Parameters:
commonData  [IN] - The common data for the session.
Exceptions:
ISoamException 

HRESULT SessionTag [in] BSTR    newVal
 

Sets the session tag.

The session tag is just a string that will be associated with the created session. Maximum length 128 characters. Default value is "", which means that no session tag is associated with the session.

Parameters:
tag  [IN] - The session tag.
Exceptions:
ISoamException 

HRESULT SessionFlags [in] LONG    newVal
 

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 ISoamSession::SessionFlags values. See samples for details.

Parameters:
flags  [IN] - The session flags.
Exceptions:
ISoamException 
See also:
ISoamSession::SessionFlags

HRESULT SessionType [in] BSTR    newVal
 

Sets the session type.

The session type argument tells Symphony which type of session to create. In the application profile, you can define different types of sessions with different attributes. For this argument, specify the name of the session type you would like to use. Default value is "".

Parameters:
type  [IN] - The session type.
Exceptions:
ISoamException 

HRESULT SessionName [in] BSTR    newVal
 

Sets the session type.

The session type argument tells Symphony which type of session to create. In the application profile, you can define different types of sessions with different attributes. For this argument, specify the name of the session type you would like to use. Default value is "".

Parameters:
type  [IN] - The session type.
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.