MessageDispatcher

Overview

This class represents a message dispatcher and is used by the Remoting SDK server channel components to associate a Message class with certain (or all) incoming requests.

Depending on the type of server channel, you can configure one of more message dispatchers to decide which Message component is used to handle incoming messages. For example, the HTTP server channel uses the path of the HTTP request to distinguish between dispatchers, while the TCP server channel can only use one message type.

Location

 

constructor

 

constructor

 

MessageDispatcher()

 

Sub New

constructor (String, IMessage)

 

constructor(name: String; message: IMessage)

 

MessageDispatcher(String name, IMessage message)

 

Sub New (name As String, message As IMessage)

Parameters:

  • name:
  • message:

constructor (String, IMessage, Boolean, Boolean)

 

constructor(name: String; message: IMessage; isEnabled: Boolean; isDefault: Boolean)

 

MessageDispatcher(String name, IMessage message, Boolean isEnabled, Boolean isDefault)

 

Sub New (name As String, message As IMessage, isEnabled As Boolean, isDefault As Boolean)

Parameters:

  • name:
  • message:
  • isEnabled:
  • isDefault:

Default

Determines whether the dispatcher is the default dispatcher for the given server channel. Channels that only serve a single dispatcher (such as the TCP server channel) will use the DefaultDispatcher property of the MessageDispatchers collection to find the default dispatcher.

 

property Default: Boolean read write;

 

Boolean Default { get; set; }

 

Property Default As Boolean

Enabled

Determines whether the dispatcher is enabled (true) or not (false). Dispatchers will only be used by the server channels if they are set to enabled.

 

property Enabled: Boolean read write;

 

Boolean Enabled { get; set; }

 

Property Enabled As Boolean

Message

Links to the Message component that is associated with this dispatcher. Several dispatchers can refer to the same Message component (e.g. if you want to share one message type for several different server channels or under different dispatcher names).

 

property Message: IMessage read write;

 

IMessage Message { get; set; }

 

Property Message As IMessage

Name

Sets the Name of the Dispatcher.

 

property Name: String read write;

 

String Name { get; set; }

 

Property Name As String

ToString

 

method ToString: String

 

String ToString()

 

Function ToString As String

 

Default

Determines whether the dispatcher is the default dispatcher for the given server channel. Channels that only serve a single dispatcher (such as the TCP server channel) will use the DefaultDispatcher property of the MessageDispatchers collection to find the default dispatcher.

 

property Default: Boolean read write;

 

Boolean Default { get; set; }

 

Property Default As Boolean

Enabled

Determines whether the dispatcher is enabled (true) or not (false). Dispatchers will only be used by the server channels if they are set to enabled.

 

property Enabled: Boolean read write;

 

Boolean Enabled { get; set; }

 

Property Enabled As Boolean

Message

Links to the Message component that is associated with this dispatcher. Several dispatchers can refer to the same Message component (e.g. if you want to share one message type for several different server channels or under different dispatcher names).

 

property Message: IMessage read write;

 

IMessage Message { get; set; }

 

Property Message As IMessage

Name

Sets the Name of the Dispatcher.

 

property Name: String read write;

 

String Name { get; set; }

 

Property Name As String

 

constructor

 

constructor

 

MessageDispatcher()

 

Sub New

constructor (String, IMessage)

 

constructor(name: String; message: IMessage)

 

MessageDispatcher(String name, IMessage message)

 

Sub New (name As String, message As IMessage)

Parameters:

  • name:
  • message:

constructor (String, IMessage, Boolean, Boolean)

 

constructor(name: String; message: IMessage; isEnabled: Boolean; isDefault: Boolean)

 

MessageDispatcher(String name, IMessage message, Boolean isEnabled, Boolean isDefault)

 

Sub New (name As String, message As IMessage, isEnabled As Boolean, isDefault As Boolean)

Parameters:

  • name:
  • message:
  • isEnabled:
  • isDefault:

ToString

 

method ToString: String

 

String ToString()

 

Function ToString As String