Platform Symphony .NET API Reference - Version 5.0
SessionFlags Enumeration
NamespacesPlatform.Symphony.SoamSessionFlags
These flags control certain characteristics of a session.
Declaration Syntax
C#
public enum SessionFlags
Members
MemberDescription
AliasPartialAsync

The Session will send its input synchronously, but receive its output asynchronously.

This is an alias for the combination of:

SendSync | ReceiveAsync


AliasSync

The Session will send its input and receive its output synchronously.

This is an alias for the combination of:

SendSync | ReceiveSync


ReceiveAsync

Indicates that the client will be collecting data from the session asynchronously. This must be done by registering for the OnResponse event of the Session.

NOTE:

This flag should not be used with any of the other Receive flags.


ReceiveSync

Indicates that the client will be collecting data from the session synchronously. This must be done using a call to Session.FetchTaskOutput.

NOTE:

This flag should not be used with any of the other Receive flags.


FetchResultsDirectly

This informs the API that the client expects that results will only be returned to the middleware upon the explicit request of the client. By default the API will cache results as they are returned from the Symphony Session Manager to boost the performance of results retrieval. Developers are strongly encouraged to fetch their results in small increments once this flag is enabled to reduce any impact to the overall performance of the Middleware during the handling of the fetch request. Note that this flag is intended for usage with the "ReceiveSync" flag.

e.g. you may create a session which will retrieve results synchronously as follows;

Examples
CopyC#
// Set up session creation attributes
SessionCreationAttributes attributes = new SessionCreationAttributes();
attributes.SessionName = "mySession";
attributes.SessionType = "ShortRunningTasks";
attributes.SessionFlags = ReceiveSync | FetchResultsDirectly;
// Now create session
session = connection.CreateSession(attributes);

See the Session::fetchTaskOutput() method for more details.


SendOverlapped
Flag to indicate that the Session will send its input to the service in an "overlapped" manner.

SendSync
Enables synchronous sending of all messages for the session.

Assembly: Platform.Symphony.Soam.Net (Module: Platform.Symphony.Soam.Net) Version: 5.0.0.0