IMessageQueueManager

Overview

The IMessageQueueManager interface represents a Message Queue Manager, a server component used to store and manage serialized server-sent event data.

Location


Required Methods

DestroyMessageQueue

Destroys a message queue assotiated with the provided client Id.

 

method DestroyMessageQueue(clientId: Guid)

 

void DestroyMessageQueue(Guid clientId)

 

Sub DestroyMessageQueue(clientId As Guid)

Parameters:

  • clientId: Client Id

FindMessageQueue

Returns an existing message queue or null if there are no message queues assotiated with the provided client Id.

 

method FindMessageQueue(clientId: Guid): IMessageQueue

 

IMessageQueue FindMessageQueue(Guid clientId)

 

Function FindMessageQueue(clientId As Guid) As IMessageQueue

Parameters:

  • clientId: Client Id

GetMessageQueue

Returns a message queue assotiated with the provided client Id. If there is no message queue assotiated with the provided client Id then a new one queue is created.

 

method GetMessageQueue(clientId: Guid): IMessageQueue

 

IMessageQueue GetMessageQueue(Guid clientId)

 

Function GetMessageQueue(clientId As Guid) As IMessageQueue

Parameters:

  • clientId: Client Id

QueueMessage (IMessage, Guid)

Enqueues serialized server-sent event data in the message queue assotiated with the provided client Id.

 

method QueueMessage(message: IMessage; clientId: Guid)

 

void QueueMessage(IMessage message, Guid clientId)

 

Sub QueueMessage(message As IMessage, clientId As Guid)

Parameters:

  • message: Message containing server-sent data
  • clientId: Client Id

QueueMessage (Stream, Guid)

Enqueues serialized server-sent event data in the message queue assotiated with the provided client Id.

 

method QueueMessage(message: Stream; clientId: Guid)

 

void QueueMessage(Stream message, Guid clientId)

 

Sub QueueMessage(message As Stream, clientId As Guid)

Parameters:

  • message: Serialized server-sent event data
  • clientId: Client Id

RegisterEventDispatcher

Registers an event dispatcher.

When an event data is enqueued Mesasge Queue Manager notifies event dispatchers assotiated with the target client Id, if any are registered. Remoting SDK uses event dispatchers to ensure that super-channels will actively push server-sent events to the connected clients.

 

method RegisterEventDispatcher(dispatcher: IEventDispatcher)

 

void RegisterEventDispatcher(IEventDispatcher dispatcher)

 

Sub RegisterEventDispatcher(dispatcher As IEventDispatcher)

Parameters:

  • dispatcher: Active event dispatcher

UnregisterEventDispatcher

 

method UnregisterEventDispatcher(clientId: Guid)

 

void UnregisterEventDispatcher(Guid clientId)

 

Sub UnregisterEventDispatcher(clientId As Guid)

Parameters:

  • clientId: