EventSinkManager
Overview
This class manages the available events and the lists of individual clients subscribed to these events on the server.
You will usually not access the public methopds of this class directly, but use the respective methods exposed by the Service base class, which does the handling of Client/Session IDs for you.
However, an instance of this class needs to be dropped (or manually created) in your server application and a Message needs to be assigned, for event handling to be available.
Location
- Reference: RemObjects.SDK.Server.dll
- Namespace: RemObjects.SDK.Server
- Ancestry: Component | EventSinkManager
constructor
constructor
EventSinkManager()
Sub New()
Dispose protected
method Dispose(disposing: Boolean)
void Dispose(Boolean disposing)
Sub Dispose(disposing As Boolean)
Parameters:
- disposing:
GetEventSink (Guid, Type): IROEventSink
Obtains a event sink proxy for the specified interface. The result value can be cast back to the event sink interface in question and then be used to call the event sink's methods. The event calls will be encoded using the Message property and then queued in the global MessageQueueManager.
method GetEventSink(senderId: Guid; eventSink: Type): IROEventSink
IROEventSink GetEventSink(Guid senderId, Type eventSink)
Function GetEventSink(senderId As Guid, eventSink As Type) As IROEventSink
Parameters:
- senderId:
- eventSink:
GetEventSink (Guid, Type, IEventTargets): IROEventSink
method GetEventSink(senderId: Guid; eventSink: Type; eventTargets: IEventTargets): IROEventSink
IROEventSink GetEventSink(Guid senderId, Type eventSink, IEventTargets eventTargets)
Function GetEventSink(senderId As Guid, eventSink As Type, eventTargets As IEventTargets) As IROEventSink
Parameters:
- senderId:
- eventSink:
- eventTargets:
Message
The message that will be used to encode all outgoing events.
property Message: IMessage read write;
IMessage Message { get; set; }
Property Message() As IMessage
RegisterEventSinkProxyClass
class method RegisterEventSinkProxyClass(eventSink: Type; eventSinkProxy: Type)
static void RegisterEventSinkProxyClass(Type eventSink, Type eventSinkProxy)
Shared Sub RegisterEventSinkProxyClass(eventSink As Type, eventSinkProxy As Type)
Parameters:
- eventSink:
- eventSinkProxy:
SubscribeClient (Guid, Type)
method SubscribeClient(clientId: Guid; eventSink: Type)
void SubscribeClient(Guid clientId, Type eventSink)
Sub SubscribeClient(clientId As Guid, eventSink As Type)
Parameters:
- clientId:
- eventSink:
SubscribeClient (Guid, Type)
class method SubscribeClient(clientId: Guid; eventSink: Type)
static void SubscribeClient(Guid clientId, Type eventSink)
Shared Sub SubscribeClient(clientId As Guid, eventSink As Type)
Parameters:
- clientId:
- eventSink:
UnsubscribeClient (Guid)
method UnsubscribeClient(clientId: Guid)
void UnsubscribeClient(Guid clientId)
Sub UnsubscribeClient(clientId As Guid)
Parameters:
- clientId:
UnsubscribeClient (Guid, Type)
method UnsubscribeClient(clientId: Guid; eventSink: Type)
void UnsubscribeClient(Guid clientId, Type eventSink)
Sub UnsubscribeClient(clientId As Guid, eventSink As Type)
Parameters:
- clientId:
- eventSink:
UnsubscribeClient (Guid)
class method UnsubscribeClient(clientId: Guid)
static void UnsubscribeClient(Guid clientId)
Shared Sub UnsubscribeClient(clientId As Guid)
Parameters:
- clientId:
UnsubscribeClient (Guid, Type)
class method UnsubscribeClient(clientId: Guid; eventSink: Type)
static void UnsubscribeClient(Guid clientId, Type eventSink)
Shared Sub UnsubscribeClient(clientId As Guid, eventSink As Type)
Parameters:
- clientId:
- eventSink:
Message
The message that will be used to encode all outgoing events.
RegisterEventSinkProxyClass
class method RegisterEventSinkProxyClass(eventSink: Type; eventSinkProxy: Type)
static void RegisterEventSinkProxyClass(Type eventSink, Type eventSinkProxy)
Shared Sub RegisterEventSinkProxyClass(eventSink As Type, eventSinkProxy As Type)
Parameters:
- eventSink:
- eventSinkProxy:
SubscribeClient (Guid, Type)
class method SubscribeClient(clientId: Guid; eventSink: Type)
static void SubscribeClient(Guid clientId, Type eventSink)
Shared Sub SubscribeClient(clientId As Guid, eventSink As Type)
Parameters:
- clientId:
- eventSink:
UnsubscribeClient (Guid)
class method UnsubscribeClient(clientId: Guid)
static void UnsubscribeClient(Guid clientId)
Shared Sub UnsubscribeClient(clientId As Guid)
Parameters:
- clientId:
UnsubscribeClient (Guid, Type)
class method UnsubscribeClient(clientId: Guid; eventSink: Type)
static void UnsubscribeClient(Guid clientId, Type eventSink)
Shared Sub UnsubscribeClient(clientId As Guid, eventSink As Type)
Parameters:
- clientId:
- eventSink:
constructor
constructor
EventSinkManager()
Sub New()
Dispose protected
method Dispose(disposing: Boolean)
void Dispose(Boolean disposing)
Sub Dispose(disposing As Boolean)
Parameters:
- disposing:
GetEventSink (Guid, Type): IROEventSink
Obtains a event sink proxy for the specified interface. The result value can be cast back to the event sink interface in question and then be used to call the event sink's methods. The event calls will be encoded using the Message property and then queued in the global MessageQueueManager.
method GetEventSink(senderId: Guid; eventSink: Type): IROEventSink
IROEventSink GetEventSink(Guid senderId, Type eventSink)
Function GetEventSink(senderId As Guid, eventSink As Type) As IROEventSink
Parameters:
- senderId:
- eventSink:
GetEventSink (Guid, Type, IEventTargets): IROEventSink
method GetEventSink(senderId: Guid; eventSink: Type; eventTargets: IEventTargets): IROEventSink
IROEventSink GetEventSink(Guid senderId, Type eventSink, IEventTargets eventTargets)
Function GetEventSink(senderId As Guid, eventSink As Type, eventTargets As IEventTargets) As IROEventSink
Parameters:
- senderId:
- eventSink:
- eventTargets:
SubscribeClient (Guid, Type)
method SubscribeClient(clientId: Guid; eventSink: Type)
void SubscribeClient(Guid clientId, Type eventSink)
Sub SubscribeClient(clientId As Guid, eventSink As Type)
Parameters:
- clientId:
- eventSink:
UnsubscribeClient (Guid)
method UnsubscribeClient(clientId: Guid)
void UnsubscribeClient(Guid clientId)
Sub UnsubscribeClient(clientId As Guid)
Parameters:
- clientId:
UnsubscribeClient (Guid, Type)
method UnsubscribeClient(clientId: Guid; eventSink: Type)
void UnsubscribeClient(Guid clientId, Type eventSink)
Sub UnsubscribeClient(clientId As Guid, eventSink As Type)
Parameters:
- clientId:
- eventSink: