Platform Symphony .NET API Reference - Version 4.1
Platform.Symphony.Soam Namespace
NamespacesPlatform.Symphony.Soam
 
Declaration Syntax
C#
namespace Platform.Symphony.Soam
Types
All TypesClassesInterfacesEnumerationsDelegates
IconTypeDescription
Connection
Represents a logical connection between the client and the SOA middleware for an application.

ConnectionSecurityCallback
This class should be extended by the application developer to allow client verification using custom security framework.

DataCompressionFlags
Data compression flags are used to modify the behavior of the data compression feature.

DefaultByteArrayMessage
A default ByteArray message implementation.

DefaultSecurityCallback
This implementation of ConnectionSecurityCallback uses the middleware's built-in security framework for client verification.

DefaultTextMessage
A default text message implementation.
Thread Safety
Static members of this type are safe for multi-threaded operations. Instance members of this type are not safe for multi-threaded operations.

DirectDataTransferFlags
Direct Data Transfer flags are used to modify the behavior of the Direct Data Transfer feature.

EnumItems
A container that holds completed task results.

SessionCallback..::.ExceptionHandler
Delegate to handle exceptions returned to the client of a session.

FailureException
Thrown to indicate a non-fatal error has occurred in the service.

FatalException
Thrown to indicate a fatal error has occurred in the service.

InputStream
Used by a Message object for reading, i.e. de-serializing.

InterruptEvent
An object that encapsulates an interruption of the service.

InterruptEventCode
This enumeration contains the codes assigned to the events being exposed to the service instance.

Message

Contains the data that is to be passed by the middleware from the client to the service, or vice versa. A Message object will use an OutputStream and an InputStream to serialize and deserialize its data, respectively.


OutputStream
Used by a Message object for writing, i.e. serializing.

SessionCallback..::.ResponseHandler
Delegate to handle responses returned to the client of a session.

ServiceContainer
An abstract class representing an object that will be used to host a service instance.

ServiceContext
Provides functionality that the service will require throughout its lifetime.

Session
Acts as a conduit for tasks being submitted to the service instances. Enables the client to manage its workload.

SessionCallback
An object that encapsulates the event handlers for the asynchronous receipt of task responses.

SessionCloseFlags
Flags to specify what action to take during the closing of the Session.

SessionContext
A container for the information associated with a particular Session. Such information may be required during the servicing of a task from a Session.

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

SessionFlags
These flags control certain characteristics of a session.

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

SessionUpdateAttributes
Container for all attributes that may be required when updating a session.
Remarks
Default values are as follows:
  • common data - This argument allows you to provide common data updates to the session. The common data udpate will become immediately avaible to the pending tasks in your session. If you require that the pending tasks for this session are not computed against this common data udpate, 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.

SessionUpdateTypes
Enumeration of all of the possible session update types.

SoamException
The base exception for all exceptions created within the Symphony API.

SoamFactory
This factory class is used to allocate the SOAM API objects for the client to provide proper lifetime management for all concrete objects in the SOAM API.

SubmissionState
The state of the message submitted from the client to the Middleware.

TaskContext
Provides the context for the task that is bound to the given service invocation.

TaskIdFilter
A task output filter that is defined by a set of task IDs.

TaskInputHandle
Will be returned to the client once a task input has been sent to the middleware, and used by the client to match a task input to the corresponding task response.

TaskOutputFilter
Abstract base class for a task output filter. A task output filter sets the criteria of which task outputs to retrieve.

TaskOutputHandle
A task response that consists of a task identifier, an output from the service (if any), and an exception (if any).

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