Platform Symphony .NET API Reference - Version 5.1
ServiceContainer Class
NamespacesPlatform.Symphony.SoamServiceContainer
An abstract class representing an object that will be used to host a service instance.
Declaration Syntax
C#
public abstract class ServiceContainer
Members
All MembersConstructorsMethods



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

OnCreateService(ServiceContext)
The middleware triggers the invocation of this handler just after a Service Instance is started.

OnDestroyService()()()()
The middleware triggers the invocation of this handler just before a Service Instance is destroyed.

OnInvoke(TaskContext)
The middleware triggers the invocation of this handler every time a task input is sent to the service to be processed.

OnServiceInterrupt(ServiceContext)
The middleware triggers the invocation of this handler every time an interrupt arrives.

OnSessionEnter(SessionContext)
The middleware triggers the invocation of this handler to bind the Service Instance to its owning Session when common data is provided by the Client.

OnSessionLeave()()()()
The middleware triggers the invocation of this handler to unbind the Service Instance from its owning Session.

OnSessionUpdate(SessionContext)
The middleware triggers the invocation of this handler to update session-specific attributes on the service. The application developer should implement code to process session updates in this handler, Default implementation of this handler does nothing. If common data is provided, this handler may be called multiple times between invocations of OnSessionEnter and OnSessionLeave, when common data updates are sent to the service.

Run()()()()
Runs the service instance.

Remarks

The application developer must extend this class to create their own service. The developer must implement the desired methods to allow the middleware to interact with the Service Instance:

  • OnInvoke (manadatory)
  • OnCreateService
  • OnDestroyService
  • OnSessionEnter
  • OnSessionLeave
  • OnServiceInterrupt

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
ServiceContainer

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