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

Implements

 

constructor  protected

Creates a new instance of the MessageQueueManager.

 

constructor

 

MessageQueueManager()

 

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)

 

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)

 

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)

 

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)

 

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: Glient id

GlobalMessageQueueManager

Global registration point for Message Queue Manager. This static property provides easy access to the globally used Interface IMessageQueueManager instance.

 

class property GlobalMessageQueueManager: IMessageQueueManager read;

 

class IMessageQueueManager GlobalMessageQueueManager { get; }

 

Shared Property ReadOnly GlobalMessageQueueManager As IMessageQueueManager

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)

 

method QueueMessage(message: Stream; clientId: Guid)

 

void QueueMessage(Stream message, Guid clientId)

 

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)

 

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)

 

Sub RegisterEventDispatcher(dispatcher As IEventDispatcher)

Parameters:

  • dispatcher: Active event dispatcher

RegisterMessageQueueManager  protected

Registers provided Interface IMessageQueueManager instance as the globally used Message Queue Manager.

 

class method RegisterMessageQueueManager(manager: IMessageQueueManager)

 

static void RegisterMessageQueueManager(IMessageQueueManager manager)

 

Shared Sub RegisterMessageQueueManager(manager As IMessageQueueManager)

Parameters:


UnregisterEventDispatcher

 

method UnregisterEventDispatcher(clientId: Guid)

 

void UnregisterEventDispatcher(Guid clientId)

 

Sub UnregisterEventDispatcher(clientId As Guid)

Parameters:

  • clientId:

UnregisterMessageQueueManager  protected

Unregisters provided Interface IMessageQueueManager instance as the globally used Message Queue Manager.

 

class method UnregisterMessageQueueManager(manager: IMessageQueueManager)

 

static void UnregisterMessageQueueManager(IMessageQueueManager manager)

 

Shared Sub UnregisterMessageQueueManager(manager As IMessageQueueManager)

Parameters:

 

GlobalMessageQueueManager

Global registration point for Message Queue Manager. This static property provides easy access to the globally used Interface IMessageQueueManager instance.

 

class property GlobalMessageQueueManager: IMessageQueueManager read;

 

class IMessageQueueManager GlobalMessageQueueManager { get; }

 

Shared Property ReadOnly GlobalMessageQueueManager As IMessageQueueManager

 

RegisterMessageQueueManager  protected

Registers provided Interface IMessageQueueManager instance as the globally used Message Queue Manager.

 

class method RegisterMessageQueueManager(manager: IMessageQueueManager)

 

static void RegisterMessageQueueManager(IMessageQueueManager manager)

 

Shared Sub RegisterMessageQueueManager(manager As IMessageQueueManager)

Parameters:


UnregisterMessageQueueManager  protected

Unregisters provided Interface IMessageQueueManager instance as the globally used Message Queue Manager.

 

class method UnregisterMessageQueueManager(manager: IMessageQueueManager)

 

static void UnregisterMessageQueueManager(IMessageQueueManager manager)

 

Shared Sub UnregisterMessageQueueManager(manager As IMessageQueueManager)

Parameters:

 

constructor  protected

Creates a new instance of the MessageQueueManager.

 

constructor

 

MessageQueueManager()

 

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)

 

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)

 

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)

 

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)

 

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: 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)

 

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)

 

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)

 

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)

 

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:

Descendants

See Also