MessageQueueManager

Overview

The MessageQueueManager is a base class for all Message Queue Manager implementations. Message Queue Managers is a server component used to store and manage serialized server-sent event data.

This class cannot be instantiated directly.

Location


Instance Methods

constructor  protected

Creates a new instance of the MessageQueueManager.

 

constructor

 

MessageQueueManager()

 

init()

 

Sub New()

constructor (IContainer)  protected

Creates a new instance of the MessageQueueManager and adds it to the provided components container.

 

constructor(container: IContainer)

 

MessageQueueManager(IContainer container)

 

init(_ container: IContainer)

 

Sub New(container As IContainer)

Parameters:

  • container: Components container

DestroyMessageQueue

Destroys a message queue assotiated with the provided client Id.

 

method DestroyMessageQueue(clientId: Guid)

 

void DestroyMessageQueue(Guid clientId)

 

func DestroyMessageQueue(_ clientId: Guid)

 

Sub DestroyMessageQueue(clientId As Guid)

Parameters:

  • clientId: Client Id

Dispose  protected

Disposes of the current Messagq Queue Manager instance.

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing: True to release both managed and unmanaged resources; false to release only unmanaged resources

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)

 

func FindMessageQueue(_ clientId: Guid) -> IMessageQueue

 

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)

 

func GetMessageQueue(_ clientId: Guid) -> IMessageQueue

 

Function GetMessageQueue(clientId As Guid) As IMessageQueue

Parameters:

  • clientId: Glient 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)

 

func QueueMessage(_ message: IMessage, _ clientId: Guid)

 

Sub QueueMessage(message As IMessage, clientId As Guid)

Parameters:

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

QueueMessage (Stream, Guid)

 

method QueueMessage(message: Stream; clientId: Guid)

 

void QueueMessage(Stream message, Guid clientId)

 

func QueueMessage(_ message: Stream, _ clientId: Guid)

 

Sub QueueMessage(message As Stream, clientId As Guid)

Parameters:

  • message:
  • clientId:

QueueMessage (Stream, IMessageQueue)  protected

 

method QueueMessage(message: Stream; queue: IMessageQueue)

 

void QueueMessage(Stream message, IMessageQueue queue)

 

func QueueMessage(_ message: Stream, _ queue: IMessageQueue)

 

Sub QueueMessage(message As Stream, queue As IMessageQueue)

Parameters:

  • message:
  • queue:

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)

 

func RegisterEventDispatcher(_ dispatcher: IEventDispatcher)

 

Sub RegisterEventDispatcher(dispatcher As IEventDispatcher)

Parameters:

  • dispatcher: Active event dispatcher

UnregisterEventDispatcher

 

method UnregisterEventDispatcher(clientId: Guid)

 

void UnregisterEventDispatcher(Guid clientId)

 

func UnregisterEventDispatcher(_ clientId: Guid)

 

Sub UnregisterEventDispatcher(clientId As Guid)

Parameters:

  • clientId: