Platform Symphony .NET API Reference - Version 5.0
CreateSession Method (sessionName)
NamespacesPlatform.Symphony.SoamConnectionCreateSession(String)
Creates a Session on this Connection with the provided attributes, or default attributes if not provided.
Declaration Syntax
C#
public Session CreateSession(
	string sessionName
)
Parameters
sessionName (String)
This is just a name for your session, so that your session can be easily identified. Maximum 1024 characters.
Return Value
The created Session
Remarks

Deprecated.

The following default attributes are applied:

  • session type - This argument tells Symphony which type of session to create. In the application profile, you can define different types of sessions with different attributes. Symphony also defines a system default session type with the name "".
  • session flags - This argument tells Symphony how you would like to send and receive task results for the session. Default value is SessionFlags.ReceiveSync, which means that you will send and receive your task results synchronously.
  • session callback - This argument allows you to provide a SessionCallback object, which allows you to register event handlers to process your session's task results asynchronously. This argument should only be provided when you have set the appropriate session flag argument to indicate that you will be receiving task results asynchronously. Default value is null - no session callback.
  • common data - This argument allows you to provide common data to 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.

Note: For recoverable sessions, all submissions will wait for a special confirmation from the middleware that the submission has been stored in a manner that it can be recovered. This means that the submission times may be longer than those of non-recoverable sessions.

Create a recoverable session by setting the recoverable flag "true" in the Application Profile.

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