Platform Symphony .NET API Reference - Version 5.1
SessionCreationAttributes Class
NamespacesPlatform.Symphony.SoamSessionCreationAttributes
Container for all attributes that may be required upon session creation.
Declaration Syntax
C#
public sealed class SessionCreationAttributes
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
SessionCreationAttributes()()()()
Initializes a new instance of the SessionCreationAttributes class

AddDefinition(ResourceAttributeDefinition)
Add resource attribute definition to resource preference object of the session.

DataCompressionFlags
Sets any flag associated with data compression.

DataCompressionThreshold
Sets the threshold for triggering data compression.

DefaultResourceAttributeValue
Sets default value of resource preference.

DirectDataTransferFlags
Sets any flags associated with Direct Data Transfer.

EnableDataCompression
Enables or disables data compression for a session.

EnableDirectDataTransfer
Enables or disables Direct Data Transfer for a session.

PreemptionRank
Sets the preemption rank of the session.

Preemptive
Specifies whether the session preempts sessions with lower priority when it has workload to run. If set to true, the session with higher priority preempts sessions with lower priority to get resources and finish the session as soon as possible.

ResourceGroupFilter
Applies a resource group filter to this session. This resource group filter overrides the one defined for the SessionType in the application profile. Tasks from a session can only run on resources that belong to one of the resource groups listed in the filter. Default value is "", meaning that no filter is specified; the application-level resource group will take effect.

ResourcePreference
Sets resource preference within the session.

ServiceName
Sets the service name to be associated with the session.

ServiceToSlotRatio
Applies a slot usage requirement to this session by specifying a service to slot ratio. This service to slot ratio overrides the one defined for the SessionType in the application profile. Tasks from this session can only run on service instances that occupy the appropriate number of slots.

SessionCallback
Sets the session callback.

SessionFlags
Sets the session flags.

SessionName
Sets the name of the session.

SessionPriority
Sets the priority of the session.

SessionTag
Sets the session tag.

SessionType
Sets the session type.

SetCommonData(Message)
Sets the common data.

SetCommonData(Object)
Sets the common data.

Remarks

NOTE: If any of the methods of this class are called after the Main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).

Inheritance Hierarchy
Object
SessionCreationAttributes
See Also
[Platform.Symphony.Soam.Connection.CreateSession]

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