Message

Overview

The Message abstract class is a base class that can be used for implementing custom Remoting SDK Message classes by providing a common base-implementation of the Interface IMessage interface. Though message components typically descend from the Message class, this is not required, but all custom messages have to implement the Interface IMessage interface.

Location

Implements

 

constructor  protected

Creates a new instance of the Message class.

This constructor can be called only from a derived class.

 

constructor

 

Message()

 

Sub New

add_AfterReadMessageParam

 

method add_AfterReadMessageParam(value: EventHandler<MessageParamEventArgs>)

 

void add_AfterReadMessageParam(EventHandler<MessageParamEventArgs> value)

 

Sub add_AfterReadMessageParam(value As EventHandler<MessageParamEventArgs>)

Parameters:

  • value:

add_AfterUnwrapEnvelopes

 

method add_AfterUnwrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void add_AfterUnwrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub add_AfterUnwrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

add_AfterWrapEnvelopes

 

method add_AfterWrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void add_AfterWrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub add_AfterWrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

add_BeforeUnwrapEnvelopes

 

method add_BeforeUnwrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void add_BeforeUnwrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub add_BeforeUnwrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

add_BeforeWrapEnvelopes

 

method add_BeforeWrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void add_BeforeWrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub add_BeforeWrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

add_BeforeWriteMessageParam

 

method add_BeforeWriteMessageParam(value: EventHandler<MessageParamEventArgs>)

 

void add_BeforeWriteMessageParam(EventHandler<MessageParamEventArgs> value)

 

Sub add_BeforeWriteMessageParam(value As EventHandler<MessageParamEventArgs>)

Parameters:

  • value:

add_OnFinalizeMessage

 

method add_OnFinalizeMessage(value: EventHandler<EventArgs>)

 

void add_OnFinalizeMessage(EventHandler<EventArgs> value)

 

Sub add_OnFinalizeMessage(value As EventHandler<EventArgs>)

Parameters:

  • value:

add_OnInitializeMessage

 

method add_OnInitializeMessage(value: EventHandler<InitMessageEventArgs>)

 

void add_OnInitializeMessage(EventHandler<InitMessageEventArgs> value)

 

Sub add_OnInitializeMessage(value As EventHandler<InitMessageEventArgs>)

Parameters:

  • value:

AddServerExceptionPrefix

 

property AddServerExceptionPrefix: Boolean read write;

 

Boolean AddServerExceptionPrefix { get; set; }

 

Property AddServerExceptionPrefix As Boolean

AfterReadMessageParam

Gets triggered after a parameter was read from the incoming message. You can use this event to inspect the parameter name, type and value.

 

event AfterReadMessageParam: EventHandler<MessageParamEventArgs>;

 

delegate EventHandler<MessageParamEventArgs> AfterReadMessageParam()

 

Event AfterReadMessageParam As EventHandler<MessageParamEventArgs>

AfterUnwrapEnvelopes

 

event AfterUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>;

 

delegate EventHandler<StreamOperationEventArgs> AfterUnwrapEnvelopes()

 

Event AfterUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>

AfterWrapEnvelopes

 

event AfterWrapEnvelopes: EventHandler<StreamOperationEventArgs>;

 

delegate EventHandler<StreamOperationEventArgs> AfterWrapEnvelopes()

 

Event AfterWrapEnvelopes As EventHandler<StreamOperationEventArgs>

BeforeUnwrapEnvelopes

 

event BeforeUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>;

 

delegate EventHandler<StreamOperationEventArgs> BeforeUnwrapEnvelopes()

 

Event BeforeUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>

BeforeWrapEnvelopes

 

event BeforeWrapEnvelopes: EventHandler<StreamOperationEventArgs>;

 

delegate EventHandler<StreamOperationEventArgs> BeforeWrapEnvelopes()

 

Event BeforeWrapEnvelopes As EventHandler<StreamOperationEventArgs>

BeforeWriteMessageParam

Gets triggered before a parameter gets written to the outgoing message. You can use this event to inspect the parameter name, type and value.

 

event BeforeWriteMessageParam: EventHandler<MessageParamEventArgs>;

 

delegate EventHandler<MessageParamEventArgs> BeforeWriteMessageParam()

 

Event BeforeWriteMessageParam As EventHandler<MessageParamEventArgs>

CheckForEnvelope  protected

 

method CheckForEnvelope(stream: Stream; out envelopeName: String): Boolean

 

Boolean CheckForEnvelope(Stream stream, out String envelopeName)

 

Function CheckForEnvelope(stream As Stream, <OutAttribute> ByRef envelopeName As String) As Boolean

Parameters:

  • stream:
  • envelopeName:

Clear

Clears all internal data structures and prepare the Message class to handle the processing of a new message.

 

method Clear

 

void Clear()

 

Sub Clear

ClearAttributes

 

method ClearAttributes(channel: IChannel)

 

void ClearAttributes(IChannel channel)

 

Sub ClearAttributes(channel As IChannel)

Parameters:

  • channel:

ClientID

Contains the Client ID for the message. Client IDs are used by the Remoting SDK for Session Management and to uniquely identify individual client on the server, for example by the Per-Client Class Factory or in your own custom code. Generally, you will not need to assign or read this value; the framework will automatically create a new unique client ID whenever a message object is instantiated on the client. However, you do have the option to read and write the ClientID property manually, for example to persist a specific client ID between shutdown and restart of your application.

 

property ClientID: Guid read write;

 

Guid ClientID { get; set; }

 

Property ClientID As Guid

Clone

Creates and returns an identical copy of the message.

 

method Clone: IMessage

 

IMessage Clone()

 

Function Clone As IMessage

CloneFrom  protected

 

method CloneFrom(message: Message)

 

void CloneFrom(Message message)

 

Sub CloneFrom(message As Message)

Parameters:

  • message:

ContentType

 

property ContentType: String read write;

 

String ContentType { get; set; }

 

Property ContentType As String

CreateException  protected

 

method CreateException(exceptionName: String; message: String): Exception

 

Exception CreateException(String exceptionName, String message)

 

Function CreateException(exceptionName As String, message As String) As Exception

Parameters:

  • exceptionName:
  • message:

DefaultDispatcherName

Returns the default/recommended dispatcher name for the message type.

 

property DefaultDispatcherName: String read;

 

String DefaultDispatcherName { get; }

 

Property ReadOnly DefaultDispatcherName As String

Dispose  protected

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

Envelopes

 

property Envelopes: MessageEnvelopes read;

 

MessageEnvelopes Envelopes { get; }

 

Property ReadOnly Envelopes As MessageEnvelopes

FinalizeMessage

This method should be implemented to ensure that the message content is complete before sending it by doing any final processing necessary. FinalizeMessage is called after all Parameters have been written to a Message and before the message will be sent. It should perform any necessary wrap-up to ensure that a subsequent call to WriteToStream() will produce a complete message.

 

method FinalizeMessage

 

void FinalizeMessage()

 

Sub FinalizeMessage

FinalizeRequest

 

method FinalizeRequest(channel: IRequest)

 

void FinalizeRequest(IRequest channel)

 

Sub FinalizeRequest(channel As IRequest)

Parameters:

  • channel:

GetExceptionMessage  protected

 

method GetExceptionMessage(exception: Exception): String

 

String GetExceptionMessage(Exception exception)

 

Function GetExceptionMessage(exception As Exception) As String

Parameters:

  • exception:

GetStream

Creates a new stream with the content of the message.

 

method GetStream: Stream

 

Stream GetStream()

 

Function GetStream As Stream

HasEnvelope

 

class method HasEnvelope(data: array of Byte): Boolean

 

static Boolean HasEnvelope(Byte[] data)

 

Shared Function HasEnvelope(data As array of Byte) As Boolean

Parameters:

  • data:

InitializeEventMessage (IChannel, String, String)

 

method InitializeEventMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeEventMessage(IChannel channel, String interfaceName, String messageName)

 

Sub InitializeEventMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeEventMessage (IChannel, String, String, String)

 

method InitializeEventMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeEventMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

Sub InitializeEventMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InitializeExceptionMessage (IChannel, String, String, Exception)

 

method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; exception: Exception)

 

void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception exception)

 

Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, exception As Exception)

Parameters:

  • channel:
  • interfaceName:
  • messageName:
  • exception:

InitializeExceptionMessage (IChannel, String, String, String, Exception)

 

method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; exception: Exception)

 

void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception exception)

 

Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, exception As Exception)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:
  • exception:

InitializeMessage (IChannel, String, String, MessageType)

 

method InitializeMessage(channel: IChannel; interfaceName: String; messageName: String; messageType: MessageType)

 

void InitializeMessage(IChannel channel, String interfaceName, String messageName, MessageType messageType)

 

Sub InitializeMessage(channel As IChannel, interfaceName As String, messageName As String, messageType As MessageType)

Parameters:

  • channel:
  • interfaceName:
  • messageName:
  • messageType:

InitializeMessage (IChannel, String, String, String, MessageType)

 

method InitializeMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; messageType: MessageType)

 

void InitializeMessage(IChannel channel, String libraryName, String interfaceName, String messageName, MessageType messageType)

 

Sub InitializeMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, messageType As MessageType)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:
  • messageType:

InitializeMessageEx

 

method InitializeMessageEx(channel: IChannel; messageType: MessageType)

 

void InitializeMessageEx(IChannel channel, MessageType messageType)

 

Sub InitializeMessageEx(channel As IChannel, messageType As MessageType)

Parameters:

  • channel:
  • messageType:

InitializeRead

 

method InitializeRead(channel: IChannel)

 

void InitializeRead(IChannel channel)

 

Sub InitializeRead(channel As IChannel)

Parameters:

  • channel:

InitializeRequest

 

method InitializeRequest(channel: IRequest)

 

void InitializeRequest(IRequest channel)

 

Sub InitializeRequest(channel As IRequest)

Parameters:

  • channel:

InitializeRequestMessage (IChannel, String, String)

 

method InitializeRequestMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeRequestMessage(IChannel channel, String interfaceName, String messageName)

 

Sub InitializeRequestMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeRequestMessage (IChannel, String, String, String)

 

method InitializeRequestMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeRequestMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

Sub InitializeRequestMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InitializeResponseMessage (IChannel, String, String)

 

method InitializeResponseMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeResponseMessage(IChannel channel, String interfaceName, String messageName)

 

Sub InitializeResponseMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeResponseMessage (IChannel, String, String, String)

 

method InitializeResponseMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeResponseMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

Sub InitializeResponseMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InitializeSerializer  protected

 

method InitializeSerializer

 

void InitializeSerializer()

 

Sub InitializeSerializer

InterfaceName

Contains the name of the interface (i.e. the service) that is being called (read-only).

 

property InterfaceName: String read write;

 

String InterfaceName { get; set; }

 

Property InterfaceName As String

IsValidMessage

 

property IsValidMessage: Boolean read;

 

Boolean IsValidMessage { get; }

 

Property ReadOnly IsValidMessage As Boolean

MessageMatchingTargetUri (String): IMessage

Creates a client message with type matching the provided target Uri. F.e. for provided uri supertcp://192.168.1.100:7020/bin this method will return an instance of the BinMessage class.

 

class method MessageMatchingTargetUri(uri: String): IMessage

 

static IMessage MessageMatchingTargetUri(String uri)

 

Shared Function MessageMatchingTargetUri(uri As String) As IMessage

Parameters:

  • uri: Server Uri

MessageMatchingTargetUri (Uri): IMessage

Creates a client message with type matching the provided target Uri. F.e. for provided uri supertcp://192.168.1.100:7020/bin this method will return an instance of the BinMessage class.

 

class method MessageMatchingTargetUri(uri: Uri): IMessage

 

static IMessage MessageMatchingTargetUri(Uri uri)

 

Shared Function MessageMatchingTargetUri(uri As Uri) As IMessage

Parameters:

  • uri: Server Uri

MessageName

Contains the name of the message (i.e. the method) that is being called (read-only).

 

property MessageName: String read write;

 

String MessageName { get; set; }

 

Property MessageName As String

MessageType

Contains the Type of message represented by the message instance.

 

property MessageType: MessageType read write;

 

MessageType MessageType { get; set; }

 

Property MessageType As MessageType

OnFinalizeMessage

Gets triggered when FinalizeMessage method was called to finalize an outgoing message just before it will be actually sent across the wire to the remote system.

 

event OnFinalizeMessage: EventHandler<EventArgs>;

 

delegate EventHandler<EventArgs> OnFinalizeMessage()

 

Event OnFinalizeMessage As EventHandler<EventArgs>

OnInitializeMessage

Gets triggered when InitializeMessage method is called to initialize an outgoing message. You can hook into this event to inspect information such as the service name and message (method) name, as well as the channel that the message is being dispatched through.

 

event OnInitializeMessage: EventHandler<InitMessageEventArgs>;

 

delegate EventHandler<InitMessageEventArgs> OnInitializeMessage()

 

Event OnInitializeMessage As EventHandler<InitMessageEventArgs>

ProcessException  protected

 

method ProcessException

 

void ProcessException()

 

Sub ProcessException

Read

 

method Read(name: String; type: Type; format: StreamingFormat): Object

 

Object Read(String name, Type type, StreamingFormat format)

 

Function Read(name As String, type As Type, format As StreamingFormat) As Object

Parameters:

  • name:
  • type:
  • format:

ReadAnsiString

Should be implemented to read an ANSI String value from the message.

 

method ReadAnsiString(name: String): String

 

String ReadAnsiString(String name)

 

Function ReadAnsiString(name As String) As String

Parameters:

  • name:

ReadBoolean

 

method ReadBoolean(name: String): Boolean

 

Boolean ReadBoolean(String name)

 

Function ReadBoolean(name As String) As Boolean

Parameters:

  • name:

ReadCurrency

 

method ReadCurrency(name: String): Decimal

 

Decimal ReadCurrency(String name)

 

Function ReadCurrency(name As String) As Decimal

Parameters:

  • name:

ReadDateTime

 

method ReadDateTime(name: String): DateTime

 

DateTime ReadDateTime(String name)

 

Function ReadDateTime(name As String) As DateTime

Parameters:

  • name:

ReadDecimal

 

method ReadDecimal(name: String): Decimal

 

Decimal ReadDecimal(String name)

 

Function ReadDecimal(name As String) As Decimal

Parameters:

  • name:

ReadDouble

 

method ReadDouble(name: String): Double

 

Double ReadDouble(String name)

 

Function ReadDouble(name As String) As Double

Parameters:

  • name:

ReadEnum

 

method ReadEnum(name: String; type: Type): Enum

 

Enum ReadEnum(String name, Type type)

 

Function ReadEnum(name As String, type As Type) As Enum

Parameters:

  • name:
  • type:

ReadException

Reads the message as an exception and then returns a new exception instance properly initialized with the message values. If no valid exception information can be found in the message, this method returns null.

 

method ReadException: Exception

 

Exception ReadException()

 

Function ReadException As Exception

ReadFromStream

Should be implemented to read the contents of the message from the given stream.

 

method ReadFromStream(stream: Stream)

 

void ReadFromStream(Stream stream)

 

Sub ReadFromStream(stream As Stream)

Parameters:

  • stream:

ReadGuid

 

method ReadGuid(name: String): Guid

 

Guid ReadGuid(String name)

 

Function ReadGuid(name As String) As Guid

Parameters:

  • name:

ReadInt32

 

method ReadInt32(name: String): Int32

 

Int32 ReadInt32(String name)

 

Function ReadInt32(name As String) As Int32

Parameters:

  • name:

ReadInt64

 

method ReadInt64(name: String): Int64

 

Int64 ReadInt64(String name)

 

Function ReadInt64(name As String) As Int64

Parameters:

  • name:

ReadUtf8String

 

method ReadUtf8String(name: String): String

 

String ReadUtf8String(String name)

 

Function ReadUtf8String(name As String) As String

Parameters:

  • name:

ReadVariant

 

method ReadVariant(name: String): Object

 

Object ReadVariant(String name)

 

Function ReadVariant(name As String) As Object

Parameters:

  • name:

ReadWideString

Should be implemented to read an Unicode Wide String value from the message.

 

method ReadWideString(name: String): String

 

String ReadWideString(String name)

 

Function ReadWideString(name As String) As String

Parameters:

  • name:

ReadXml

 

method ReadXml(name: String): XmlNode

 

XmlNode ReadXml(String name)

 

Function ReadXml(name As String) As XmlNode

Parameters:

  • name:

remove_AfterReadMessageParam

 

method remove_AfterReadMessageParam(value: EventHandler<MessageParamEventArgs>)

 

void remove_AfterReadMessageParam(EventHandler<MessageParamEventArgs> value)

 

Sub remove_AfterReadMessageParam(value As EventHandler<MessageParamEventArgs>)

Parameters:

  • value:

remove_AfterUnwrapEnvelopes

 

method remove_AfterUnwrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void remove_AfterUnwrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub remove_AfterUnwrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

remove_AfterWrapEnvelopes

 

method remove_AfterWrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void remove_AfterWrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub remove_AfterWrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

remove_BeforeUnwrapEnvelopes

 

method remove_BeforeUnwrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void remove_BeforeUnwrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub remove_BeforeUnwrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

remove_BeforeWrapEnvelopes

 

method remove_BeforeWrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void remove_BeforeWrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub remove_BeforeWrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

remove_BeforeWriteMessageParam

 

method remove_BeforeWriteMessageParam(value: EventHandler<MessageParamEventArgs>)

 

void remove_BeforeWriteMessageParam(EventHandler<MessageParamEventArgs> value)

 

Sub remove_BeforeWriteMessageParam(value As EventHandler<MessageParamEventArgs>)

Parameters:

  • value:

remove_OnFinalizeMessage

 

method remove_OnFinalizeMessage(value: EventHandler<EventArgs>)

 

void remove_OnFinalizeMessage(EventHandler<EventArgs> value)

 

Sub remove_OnFinalizeMessage(value As EventHandler<EventArgs>)

Parameters:

  • value:

remove_OnInitializeMessage

 

method remove_OnInitializeMessage(value: EventHandler<InitMessageEventArgs>)

 

void remove_OnInitializeMessage(EventHandler<InitMessageEventArgs> value)

 

Sub remove_OnInitializeMessage(value As EventHandler<InitMessageEventArgs>)

Parameters:

  • value:

SerializerInstance

This is the Serializer used to write values to the message. Descendant classes will set this property to a custom Serializer class within their InitializeMessage or ReadFromStream methods, so that future calls to the Read* and Write* methods can access the custom Serializer.

 

property SerializerInstance: Serializer read write;

 

Serializer SerializerInstance { get; set; }

 

Property SerializerInstance As Serializer

ServerExceptionPrefix

 

property ServerExceptionPrefix: String read write;

 

String ServerExceptionPrefix { get; set; }

 

Property ServerExceptionPrefix As String

SetAttributes

 

method SetAttributes(channel: IChannel; attributeNames: array of String; attributeValues: array of String)

 

void SetAttributes(IChannel channel, String[] attributeNames, String[] attributeValues)

 

Sub SetAttributes(channel As IChannel, attributeNames As array of String, attributeValues As array of String)

Parameters:

  • channel:
  • attributeNames:
  • attributeValues:

TriggerAfterReadMessageParam (String, Object)  protected

 

method TriggerAfterReadMessageParam(name: String; parameter: Object)

 

void TriggerAfterReadMessageParam(String name, Object parameter)

 

Sub TriggerAfterReadMessageParam(name As String, parameter As Object)

Parameters:

  • name:
  • parameter:

TriggerAfterReadMessageParam (String, Object, Type)  protected

 

method TriggerAfterReadMessageParam(name: String; parameter: Object; type: Type)

 

void TriggerAfterReadMessageParam(String name, Object parameter, Type type)

 

Sub TriggerAfterReadMessageParam(name As String, parameter As Object, type As Type)

Parameters:

  • name:
  • parameter:
  • type:

TriggerAfterReadMessageParam (String, Object, Type, StreamingFormat)  protected

 

method TriggerAfterReadMessageParam(name: String; parameter: Object; type: Type; format: StreamingFormat)

 

void TriggerAfterReadMessageParam(String name, Object parameter, Type type, StreamingFormat format)

 

Sub TriggerAfterReadMessageParam(name As String, parameter As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • parameter:
  • type:
  • format:

TriggerAfterUnwrapEnvelopes  protected

 

method TriggerAfterUnwrapEnvelopes(stream: Stream)

 

void TriggerAfterUnwrapEnvelopes(Stream stream)

 

Sub TriggerAfterUnwrapEnvelopes(stream As Stream)

Parameters:

  • stream:

TriggerAfterWrapEnvelopes  protected

 

method TriggerAfterWrapEnvelopes(stream: Stream)

 

void TriggerAfterWrapEnvelopes(Stream stream)

 

Sub TriggerAfterWrapEnvelopes(stream As Stream)

Parameters:

  • stream:

TriggerBeforeUnwrapEnvelopes  protected

 

method TriggerBeforeUnwrapEnvelopes(stream: Stream)

 

void TriggerBeforeUnwrapEnvelopes(Stream stream)

 

Sub TriggerBeforeUnwrapEnvelopes(stream As Stream)

Parameters:

  • stream:

TriggerBeforeWrapEnvelopes  protected

 

method TriggerBeforeWrapEnvelopes(stream: Stream)

 

void TriggerBeforeWrapEnvelopes(Stream stream)

 

Sub TriggerBeforeWrapEnvelopes(stream As Stream)

Parameters:

  • stream:

TriggerBeforeWriteMessageParam (String, Object)  protected

 

method TriggerBeforeWriteMessageParam(name: String; parameter: Object)

 

void TriggerBeforeWriteMessageParam(String name, Object parameter)

 

Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object)

Parameters:

  • name:
  • parameter:

TriggerBeforeWriteMessageParam (String, Object, Type)  protected

 

method TriggerBeforeWriteMessageParam(name: String; parameter: Object; type: Type)

 

void TriggerBeforeWriteMessageParam(String name, Object parameter, Type type)

 

Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object, type As Type)

Parameters:

  • name:
  • parameter:
  • type:

TriggerBeforeWriteMessageParam (String, Object, Type, StreamingFormat)  protected

 

method TriggerBeforeWriteMessageParam(name: String; parameter: Object; type: Type; format: StreamingFormat)

 

void TriggerBeforeWriteMessageParam(String name, Object parameter, Type type, StreamingFormat format)

 

Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • parameter:
  • type:
  • format:

TriggerOnFinalizeMessage  protected

 

method TriggerOnFinalizeMessage

 

void TriggerOnFinalizeMessage()

 

Sub TriggerOnFinalizeMessage

TriggerOnInitializeMessage  protected

 

method TriggerOnInitializeMessage(channel: IChannel; interfaceName: String; messageName: String; exception: Exception)

 

void TriggerOnInitializeMessage(IChannel channel, String interfaceName, String messageName, Exception exception)

 

Sub TriggerOnInitializeMessage(channel As IChannel, interfaceName As String, messageName As String, exception As Exception)

Parameters:

  • channel:
  • interfaceName:
  • messageName:
  • exception:

UnwrapEnvelopes  protected

 

method UnwrapEnvelopes(stream: Stream): Stream

 

Stream UnwrapEnvelopes(Stream stream)

 

Function UnwrapEnvelopes(stream As Stream) As Stream

Parameters:

  • stream:

Validate

 

method Validate(content: String): Boolean

 

Boolean Validate(String content)

 

Function Validate(content As String) As Boolean

Parameters:

  • content:

WrapEnvelopes  protected

 

method WrapEnvelopes(stream: Stream): Stream

 

Stream WrapEnvelopes(Stream stream)

 

Function WrapEnvelopes(stream As Stream) As Stream

Parameters:

  • stream:

Write

 

method Write(name: String; value: Object; type: Type; format: StreamingFormat)

 

void Write(String name, Object value, Type type, StreamingFormat format)

 

Sub Write(name As String, value As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • type:
  • format:

WriteAnsiString

Should be implemented to write an ANSI String value to the message.

 

method WriteAnsiString(name: String; value: String)

 

void WriteAnsiString(String name, String value)

 

Sub WriteAnsiString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteBoolean

 

method WriteBoolean(name: String; value: Boolean)

 

void WriteBoolean(String name, Boolean value)

 

Sub WriteBoolean(name As String, value As Boolean)

Parameters:

  • name:
  • value:

WriteCurrency

 

method WriteCurrency(name: String; value: Decimal)

 

void WriteCurrency(String name, Decimal value)

 

Sub WriteCurrency(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDateTime

 

method WriteDateTime(name: String; value: DateTime)

 

void WriteDateTime(String name, DateTime value)

 

Sub WriteDateTime(name As String, value As DateTime)

Parameters:

  • name:
  • value:

WriteDecimal

 

method WriteDecimal(name: String; value: Decimal)

 

void WriteDecimal(String name, Decimal value)

 

Sub WriteDecimal(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDouble

 

method WriteDouble(name: String; value: Double)

 

void WriteDouble(String name, Double value)

 

Sub WriteDouble(name As String, value As Double)

Parameters:

  • name:
  • value:

WriteEnum

 

method WriteEnum(name: String; value: Enum)

 

void WriteEnum(String name, Enum value)

 

Sub WriteEnum(name As String, value As Enum)

Parameters:

  • name:
  • value:

WriteEnvelopeHeader

 

method WriteEnvelopeHeader(envelope: MessageEnvelope; stream: Stream)

 

void WriteEnvelopeHeader(MessageEnvelope envelope, Stream stream)

 

Sub WriteEnvelopeHeader(envelope As MessageEnvelope, stream As Stream)

Parameters:

  • envelope:
  • stream:

WriteException

 

method WriteException(exception: Exception)

 

void WriteException(Exception exception)

 

Sub WriteException(exception As Exception)

Parameters:

  • exception:

WriteGuid

 

method WriteGuid(name: String; value: Guid)

 

void WriteGuid(String name, Guid value)

 

Sub WriteGuid(name As String, value As Guid)

Parameters:

  • name:
  • value:

WriteInt32

 

method WriteInt32(name: String; value: Int32)

 

void WriteInt32(String name, Int32 value)

 

Sub WriteInt32(name As String, value As Int32)

Parameters:

  • name:
  • value:

WriteInt64

 

method WriteInt64(name: String; value: Int64)

 

void WriteInt64(String name, Int64 value)

 

Sub WriteInt64(name As String, value As Int64)

Parameters:

  • name:
  • value:

WriteToStream

 

method WriteToStream(stream: Stream)

 

void WriteToStream(Stream stream)

 

Sub WriteToStream(stream As Stream)

Parameters:

  • stream:

WriteUtf8String

 

method WriteUtf8String(name: String; value: String)

 

void WriteUtf8String(String name, String value)

 

Sub WriteUtf8String(name As String, value As String)

Parameters:

  • name:
  • value:

WriteVariant

 

method WriteVariant(name: String; value: Object)

 

void WriteVariant(String name, Object value)

 

Sub WriteVariant(name As String, value As Object)

Parameters:

  • name:
  • value:

WriteWideString

 

method WriteWideString(name: String; value: String)

 

void WriteWideString(String name, String value)

 

Sub WriteWideString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteXml

 

method WriteXml(name: String; value: XmlNode)

 

void WriteXml(String name, XmlNode value)

 

Sub WriteXml(name As String, value As XmlNode)

Parameters:

  • name:
  • value:

 

AddServerExceptionPrefix

 

property AddServerExceptionPrefix: Boolean read write;

 

Boolean AddServerExceptionPrefix { get; set; }

 

Property AddServerExceptionPrefix As Boolean

ClientID

Contains the Client ID for the message. Client IDs are used by the Remoting SDK for Session Management and to uniquely identify individual client on the server, for example by the Per-Client Class Factory or in your own custom code. Generally, you will not need to assign or read this value; the framework will automatically create a new unique client ID whenever a message object is instantiated on the client. However, you do have the option to read and write the ClientID property manually, for example to persist a specific client ID between shutdown and restart of your application.

 

property ClientID: Guid read write;

 

Guid ClientID { get; set; }

 

Property ClientID As Guid

ContentType

 

property ContentType: String read write;

 

String ContentType { get; set; }

 

Property ContentType As String

DefaultDispatcherName

Returns the default/recommended dispatcher name for the message type.

 

property DefaultDispatcherName: String read;

 

String DefaultDispatcherName { get; }

 

Property ReadOnly DefaultDispatcherName As String

Envelopes

 

property Envelopes: MessageEnvelopes read;

 

MessageEnvelopes Envelopes { get; }

 

Property ReadOnly Envelopes As MessageEnvelopes

InterfaceName

Contains the name of the interface (i.e. the service) that is being called (read-only).

 

property InterfaceName: String read write;

 

String InterfaceName { get; set; }

 

Property InterfaceName As String

IsValidMessage

 

property IsValidMessage: Boolean read;

 

Boolean IsValidMessage { get; }

 

Property ReadOnly IsValidMessage As Boolean

MessageName

Contains the name of the message (i.e. the method) that is being called (read-only).

 

property MessageName: String read write;

 

String MessageName { get; set; }

 

Property MessageName As String

MessageType

Contains the Type of message represented by the message instance.

 

property MessageType: MessageType read write;

 

MessageType MessageType { get; set; }

 

Property MessageType As MessageType

SerializerInstance

This is the Serializer used to write values to the message. Descendant classes will set this property to a custom Serializer class within their InitializeMessage or ReadFromStream methods, so that future calls to the Read* and Write* methods can access the custom Serializer.

 

property SerializerInstance: Serializer read write;

 

Serializer SerializerInstance { get; set; }

 

Property SerializerInstance As Serializer

ServerExceptionPrefix

 

property ServerExceptionPrefix: String read write;

 

String ServerExceptionPrefix { get; set; }

 

Property ServerExceptionPrefix As String

 

HasEnvelope

 

class method HasEnvelope(data: array of Byte): Boolean

 

static Boolean HasEnvelope(Byte[] data)

 

Shared Function HasEnvelope(data As array of Byte) As Boolean

Parameters:

  • data:

MessageMatchingTargetUri (String): IMessage

Creates a client message with type matching the provided target Uri. F.e. for provided uri supertcp://192.168.1.100:7020/bin this method will return an instance of the BinMessage class.

 

class method MessageMatchingTargetUri(uri: String): IMessage

 

static IMessage MessageMatchingTargetUri(String uri)

 

Shared Function MessageMatchingTargetUri(uri As String) As IMessage

Parameters:

  • uri: Server Uri

MessageMatchingTargetUri (Uri): IMessage

Creates a client message with type matching the provided target Uri. F.e. for provided uri supertcp://192.168.1.100:7020/bin this method will return an instance of the BinMessage class.

 

class method MessageMatchingTargetUri(uri: Uri): IMessage

 

static IMessage MessageMatchingTargetUri(Uri uri)

 

Shared Function MessageMatchingTargetUri(uri As Uri) As IMessage

Parameters:

  • uri: Server Uri

 

constructor  protected

Creates a new instance of the Message class.

This constructor can be called only from a derived class.

 

constructor

 

Message()

 

Sub New

add_AfterReadMessageParam

 

method add_AfterReadMessageParam(value: EventHandler<MessageParamEventArgs>)

 

void add_AfterReadMessageParam(EventHandler<MessageParamEventArgs> value)

 

Sub add_AfterReadMessageParam(value As EventHandler<MessageParamEventArgs>)

Parameters:

  • value:

add_AfterUnwrapEnvelopes

 

method add_AfterUnwrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void add_AfterUnwrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub add_AfterUnwrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

add_AfterWrapEnvelopes

 

method add_AfterWrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void add_AfterWrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub add_AfterWrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

add_BeforeUnwrapEnvelopes

 

method add_BeforeUnwrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void add_BeforeUnwrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub add_BeforeUnwrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

add_BeforeWrapEnvelopes

 

method add_BeforeWrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void add_BeforeWrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub add_BeforeWrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

add_BeforeWriteMessageParam

 

method add_BeforeWriteMessageParam(value: EventHandler<MessageParamEventArgs>)

 

void add_BeforeWriteMessageParam(EventHandler<MessageParamEventArgs> value)

 

Sub add_BeforeWriteMessageParam(value As EventHandler<MessageParamEventArgs>)

Parameters:

  • value:

add_OnFinalizeMessage

 

method add_OnFinalizeMessage(value: EventHandler<EventArgs>)

 

void add_OnFinalizeMessage(EventHandler<EventArgs> value)

 

Sub add_OnFinalizeMessage(value As EventHandler<EventArgs>)

Parameters:

  • value:

add_OnInitializeMessage

 

method add_OnInitializeMessage(value: EventHandler<InitMessageEventArgs>)

 

void add_OnInitializeMessage(EventHandler<InitMessageEventArgs> value)

 

Sub add_OnInitializeMessage(value As EventHandler<InitMessageEventArgs>)

Parameters:

  • value:

CheckForEnvelope  protected

 

method CheckForEnvelope(stream: Stream; out envelopeName: String): Boolean

 

Boolean CheckForEnvelope(Stream stream, out String envelopeName)

 

Function CheckForEnvelope(stream As Stream, <OutAttribute> ByRef envelopeName As String) As Boolean

Parameters:

  • stream:
  • envelopeName:

Clear

Clears all internal data structures and prepare the Message class to handle the processing of a new message.

 

method Clear

 

void Clear()

 

Sub Clear

ClearAttributes

 

method ClearAttributes(channel: IChannel)

 

void ClearAttributes(IChannel channel)

 

Sub ClearAttributes(channel As IChannel)

Parameters:

  • channel:

Clone

Creates and returns an identical copy of the message.

 

method Clone: IMessage

 

IMessage Clone()

 

Function Clone As IMessage

CloneFrom  protected

 

method CloneFrom(message: Message)

 

void CloneFrom(Message message)

 

Sub CloneFrom(message As Message)

Parameters:

  • message:

CreateException  protected

 

method CreateException(exceptionName: String; message: String): Exception

 

Exception CreateException(String exceptionName, String message)

 

Function CreateException(exceptionName As String, message As String) As Exception

Parameters:

  • exceptionName:
  • message:

Dispose  protected

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

FinalizeMessage

This method should be implemented to ensure that the message content is complete before sending it by doing any final processing necessary. FinalizeMessage is called after all Parameters have been written to a Message and before the message will be sent. It should perform any necessary wrap-up to ensure that a subsequent call to WriteToStream() will produce a complete message.

 

method FinalizeMessage

 

void FinalizeMessage()

 

Sub FinalizeMessage

FinalizeRequest

 

method FinalizeRequest(channel: IRequest)

 

void FinalizeRequest(IRequest channel)

 

Sub FinalizeRequest(channel As IRequest)

Parameters:

  • channel:

GetExceptionMessage  protected

 

method GetExceptionMessage(exception: Exception): String

 

String GetExceptionMessage(Exception exception)

 

Function GetExceptionMessage(exception As Exception) As String

Parameters:

  • exception:

GetStream

Creates a new stream with the content of the message.

 

method GetStream: Stream

 

Stream GetStream()

 

Function GetStream As Stream

InitializeEventMessage (IChannel, String, String)

 

method InitializeEventMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeEventMessage(IChannel channel, String interfaceName, String messageName)

 

Sub InitializeEventMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeEventMessage (IChannel, String, String, String)

 

method InitializeEventMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeEventMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

Sub InitializeEventMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InitializeExceptionMessage (IChannel, String, String, Exception)

 

method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; exception: Exception)

 

void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception exception)

 

Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, exception As Exception)

Parameters:

  • channel:
  • interfaceName:
  • messageName:
  • exception:

InitializeExceptionMessage (IChannel, String, String, String, Exception)

 

method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; exception: Exception)

 

void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception exception)

 

Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, exception As Exception)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:
  • exception:

InitializeMessage (IChannel, String, String, MessageType)

 

method InitializeMessage(channel: IChannel; interfaceName: String; messageName: String; messageType: MessageType)

 

void InitializeMessage(IChannel channel, String interfaceName, String messageName, MessageType messageType)

 

Sub InitializeMessage(channel As IChannel, interfaceName As String, messageName As String, messageType As MessageType)

Parameters:

  • channel:
  • interfaceName:
  • messageName:
  • messageType:

InitializeMessage (IChannel, String, String, String, MessageType)

 

method InitializeMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; messageType: MessageType)

 

void InitializeMessage(IChannel channel, String libraryName, String interfaceName, String messageName, MessageType messageType)

 

Sub InitializeMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, messageType As MessageType)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:
  • messageType:

InitializeMessageEx

 

method InitializeMessageEx(channel: IChannel; messageType: MessageType)

 

void InitializeMessageEx(IChannel channel, MessageType messageType)

 

Sub InitializeMessageEx(channel As IChannel, messageType As MessageType)

Parameters:

  • channel:
  • messageType:

InitializeRead

 

method InitializeRead(channel: IChannel)

 

void InitializeRead(IChannel channel)

 

Sub InitializeRead(channel As IChannel)

Parameters:

  • channel:

InitializeRequest

 

method InitializeRequest(channel: IRequest)

 

void InitializeRequest(IRequest channel)

 

Sub InitializeRequest(channel As IRequest)

Parameters:

  • channel:

InitializeRequestMessage (IChannel, String, String)

 

method InitializeRequestMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeRequestMessage(IChannel channel, String interfaceName, String messageName)

 

Sub InitializeRequestMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeRequestMessage (IChannel, String, String, String)

 

method InitializeRequestMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeRequestMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

Sub InitializeRequestMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InitializeResponseMessage (IChannel, String, String)

 

method InitializeResponseMessage(channel: IChannel; interfaceName: String; messageName: String)

 

void InitializeResponseMessage(IChannel channel, String interfaceName, String messageName)

 

Sub InitializeResponseMessage(channel As IChannel, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • interfaceName:
  • messageName:

InitializeResponseMessage (IChannel, String, String, String)

 

method InitializeResponseMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)

 

void InitializeResponseMessage(IChannel channel, String libraryName, String interfaceName, String messageName)

 

Sub InitializeResponseMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)

Parameters:

  • channel:
  • libraryName:
  • interfaceName:
  • messageName:

InitializeSerializer  protected

 

method InitializeSerializer

 

void InitializeSerializer()

 

Sub InitializeSerializer

ProcessException  protected

 

method ProcessException

 

void ProcessException()

 

Sub ProcessException

Read

 

method Read(name: String; type: Type; format: StreamingFormat): Object

 

Object Read(String name, Type type, StreamingFormat format)

 

Function Read(name As String, type As Type, format As StreamingFormat) As Object

Parameters:

  • name:
  • type:
  • format:

ReadAnsiString

Should be implemented to read an ANSI String value from the message.

 

method ReadAnsiString(name: String): String

 

String ReadAnsiString(String name)

 

Function ReadAnsiString(name As String) As String

Parameters:

  • name:

ReadBoolean

 

method ReadBoolean(name: String): Boolean

 

Boolean ReadBoolean(String name)

 

Function ReadBoolean(name As String) As Boolean

Parameters:

  • name:

ReadCurrency

 

method ReadCurrency(name: String): Decimal

 

Decimal ReadCurrency(String name)

 

Function ReadCurrency(name As String) As Decimal

Parameters:

  • name:

ReadDateTime

 

method ReadDateTime(name: String): DateTime

 

DateTime ReadDateTime(String name)

 

Function ReadDateTime(name As String) As DateTime

Parameters:

  • name:

ReadDecimal

 

method ReadDecimal(name: String): Decimal

 

Decimal ReadDecimal(String name)

 

Function ReadDecimal(name As String) As Decimal

Parameters:

  • name:

ReadDouble

 

method ReadDouble(name: String): Double

 

Double ReadDouble(String name)

 

Function ReadDouble(name As String) As Double

Parameters:

  • name:

ReadEnum

 

method ReadEnum(name: String; type: Type): Enum

 

Enum ReadEnum(String name, Type type)

 

Function ReadEnum(name As String, type As Type) As Enum

Parameters:

  • name:
  • type:

ReadException

Reads the message as an exception and then returns a new exception instance properly initialized with the message values. If no valid exception information can be found in the message, this method returns null.

 

method ReadException: Exception

 

Exception ReadException()

 

Function ReadException As Exception

ReadFromStream

Should be implemented to read the contents of the message from the given stream.

 

method ReadFromStream(stream: Stream)

 

void ReadFromStream(Stream stream)

 

Sub ReadFromStream(stream As Stream)

Parameters:

  • stream:

ReadGuid

 

method ReadGuid(name: String): Guid

 

Guid ReadGuid(String name)

 

Function ReadGuid(name As String) As Guid

Parameters:

  • name:

ReadInt32

 

method ReadInt32(name: String): Int32

 

Int32 ReadInt32(String name)

 

Function ReadInt32(name As String) As Int32

Parameters:

  • name:

ReadInt64

 

method ReadInt64(name: String): Int64

 

Int64 ReadInt64(String name)

 

Function ReadInt64(name As String) As Int64

Parameters:

  • name:

ReadUtf8String

 

method ReadUtf8String(name: String): String

 

String ReadUtf8String(String name)

 

Function ReadUtf8String(name As String) As String

Parameters:

  • name:

ReadVariant

 

method ReadVariant(name: String): Object

 

Object ReadVariant(String name)

 

Function ReadVariant(name As String) As Object

Parameters:

  • name:

ReadWideString

Should be implemented to read an Unicode Wide String value from the message.

 

method ReadWideString(name: String): String

 

String ReadWideString(String name)

 

Function ReadWideString(name As String) As String

Parameters:

  • name:

ReadXml

 

method ReadXml(name: String): XmlNode

 

XmlNode ReadXml(String name)

 

Function ReadXml(name As String) As XmlNode

Parameters:

  • name:

remove_AfterReadMessageParam

 

method remove_AfterReadMessageParam(value: EventHandler<MessageParamEventArgs>)

 

void remove_AfterReadMessageParam(EventHandler<MessageParamEventArgs> value)

 

Sub remove_AfterReadMessageParam(value As EventHandler<MessageParamEventArgs>)

Parameters:

  • value:

remove_AfterUnwrapEnvelopes

 

method remove_AfterUnwrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void remove_AfterUnwrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub remove_AfterUnwrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

remove_AfterWrapEnvelopes

 

method remove_AfterWrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void remove_AfterWrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub remove_AfterWrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

remove_BeforeUnwrapEnvelopes

 

method remove_BeforeUnwrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void remove_BeforeUnwrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub remove_BeforeUnwrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

remove_BeforeWrapEnvelopes

 

method remove_BeforeWrapEnvelopes(value: EventHandler<StreamOperationEventArgs>)

 

void remove_BeforeWrapEnvelopes(EventHandler<StreamOperationEventArgs> value)

 

Sub remove_BeforeWrapEnvelopes(value As EventHandler<StreamOperationEventArgs>)

Parameters:

  • value:

remove_BeforeWriteMessageParam

 

method remove_BeforeWriteMessageParam(value: EventHandler<MessageParamEventArgs>)

 

void remove_BeforeWriteMessageParam(EventHandler<MessageParamEventArgs> value)

 

Sub remove_BeforeWriteMessageParam(value As EventHandler<MessageParamEventArgs>)

Parameters:

  • value:

remove_OnFinalizeMessage

 

method remove_OnFinalizeMessage(value: EventHandler<EventArgs>)

 

void remove_OnFinalizeMessage(EventHandler<EventArgs> value)

 

Sub remove_OnFinalizeMessage(value As EventHandler<EventArgs>)

Parameters:

  • value:

remove_OnInitializeMessage

 

method remove_OnInitializeMessage(value: EventHandler<InitMessageEventArgs>)

 

void remove_OnInitializeMessage(EventHandler<InitMessageEventArgs> value)

 

Sub remove_OnInitializeMessage(value As EventHandler<InitMessageEventArgs>)

Parameters:

  • value:

SetAttributes

 

method SetAttributes(channel: IChannel; attributeNames: array of String; attributeValues: array of String)

 

void SetAttributes(IChannel channel, String[] attributeNames, String[] attributeValues)

 

Sub SetAttributes(channel As IChannel, attributeNames As array of String, attributeValues As array of String)

Parameters:

  • channel:
  • attributeNames:
  • attributeValues:

TriggerAfterReadMessageParam (String, Object)  protected

 

method TriggerAfterReadMessageParam(name: String; parameter: Object)

 

void TriggerAfterReadMessageParam(String name, Object parameter)

 

Sub TriggerAfterReadMessageParam(name As String, parameter As Object)

Parameters:

  • name:
  • parameter:

TriggerAfterReadMessageParam (String, Object, Type)  protected

 

method TriggerAfterReadMessageParam(name: String; parameter: Object; type: Type)

 

void TriggerAfterReadMessageParam(String name, Object parameter, Type type)

 

Sub TriggerAfterReadMessageParam(name As String, parameter As Object, type As Type)

Parameters:

  • name:
  • parameter:
  • type:

TriggerAfterReadMessageParam (String, Object, Type, StreamingFormat)  protected

 

method TriggerAfterReadMessageParam(name: String; parameter: Object; type: Type; format: StreamingFormat)

 

void TriggerAfterReadMessageParam(String name, Object parameter, Type type, StreamingFormat format)

 

Sub TriggerAfterReadMessageParam(name As String, parameter As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • parameter:
  • type:
  • format:

TriggerAfterUnwrapEnvelopes  protected

 

method TriggerAfterUnwrapEnvelopes(stream: Stream)

 

void TriggerAfterUnwrapEnvelopes(Stream stream)

 

Sub TriggerAfterUnwrapEnvelopes(stream As Stream)

Parameters:

  • stream:

TriggerAfterWrapEnvelopes  protected

 

method TriggerAfterWrapEnvelopes(stream: Stream)

 

void TriggerAfterWrapEnvelopes(Stream stream)

 

Sub TriggerAfterWrapEnvelopes(stream As Stream)

Parameters:

  • stream:

TriggerBeforeUnwrapEnvelopes  protected

 

method TriggerBeforeUnwrapEnvelopes(stream: Stream)

 

void TriggerBeforeUnwrapEnvelopes(Stream stream)

 

Sub TriggerBeforeUnwrapEnvelopes(stream As Stream)

Parameters:

  • stream:

TriggerBeforeWrapEnvelopes  protected

 

method TriggerBeforeWrapEnvelopes(stream: Stream)

 

void TriggerBeforeWrapEnvelopes(Stream stream)

 

Sub TriggerBeforeWrapEnvelopes(stream As Stream)

Parameters:

  • stream:

TriggerBeforeWriteMessageParam (String, Object)  protected

 

method TriggerBeforeWriteMessageParam(name: String; parameter: Object)

 

void TriggerBeforeWriteMessageParam(String name, Object parameter)

 

Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object)

Parameters:

  • name:
  • parameter:

TriggerBeforeWriteMessageParam (String, Object, Type)  protected

 

method TriggerBeforeWriteMessageParam(name: String; parameter: Object; type: Type)

 

void TriggerBeforeWriteMessageParam(String name, Object parameter, Type type)

 

Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object, type As Type)

Parameters:

  • name:
  • parameter:
  • type:

TriggerBeforeWriteMessageParam (String, Object, Type, StreamingFormat)  protected

 

method TriggerBeforeWriteMessageParam(name: String; parameter: Object; type: Type; format: StreamingFormat)

 

void TriggerBeforeWriteMessageParam(String name, Object parameter, Type type, StreamingFormat format)

 

Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • parameter:
  • type:
  • format:

TriggerOnFinalizeMessage  protected

 

method TriggerOnFinalizeMessage

 

void TriggerOnFinalizeMessage()

 

Sub TriggerOnFinalizeMessage

TriggerOnInitializeMessage  protected

 

method TriggerOnInitializeMessage(channel: IChannel; interfaceName: String; messageName: String; exception: Exception)

 

void TriggerOnInitializeMessage(IChannel channel, String interfaceName, String messageName, Exception exception)

 

Sub TriggerOnInitializeMessage(channel As IChannel, interfaceName As String, messageName As String, exception As Exception)

Parameters:

  • channel:
  • interfaceName:
  • messageName:
  • exception:

UnwrapEnvelopes  protected

 

method UnwrapEnvelopes(stream: Stream): Stream

 

Stream UnwrapEnvelopes(Stream stream)

 

Function UnwrapEnvelopes(stream As Stream) As Stream

Parameters:

  • stream:

Validate

 

method Validate(content: String): Boolean

 

Boolean Validate(String content)

 

Function Validate(content As String) As Boolean

Parameters:

  • content:

WrapEnvelopes  protected

 

method WrapEnvelopes(stream: Stream): Stream

 

Stream WrapEnvelopes(Stream stream)

 

Function WrapEnvelopes(stream As Stream) As Stream

Parameters:

  • stream:

Write

 

method Write(name: String; value: Object; type: Type; format: StreamingFormat)

 

void Write(String name, Object value, Type type, StreamingFormat format)

 

Sub Write(name As String, value As Object, type As Type, format As StreamingFormat)

Parameters:

  • name:
  • value:
  • type:
  • format:

WriteAnsiString

Should be implemented to write an ANSI String value to the message.

 

method WriteAnsiString(name: String; value: String)

 

void WriteAnsiString(String name, String value)

 

Sub WriteAnsiString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteBoolean

 

method WriteBoolean(name: String; value: Boolean)

 

void WriteBoolean(String name, Boolean value)

 

Sub WriteBoolean(name As String, value As Boolean)

Parameters:

  • name:
  • value:

WriteCurrency

 

method WriteCurrency(name: String; value: Decimal)

 

void WriteCurrency(String name, Decimal value)

 

Sub WriteCurrency(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDateTime

 

method WriteDateTime(name: String; value: DateTime)

 

void WriteDateTime(String name, DateTime value)

 

Sub WriteDateTime(name As String, value As DateTime)

Parameters:

  • name:
  • value:

WriteDecimal

 

method WriteDecimal(name: String; value: Decimal)

 

void WriteDecimal(String name, Decimal value)

 

Sub WriteDecimal(name As String, value As Decimal)

Parameters:

  • name:
  • value:

WriteDouble

 

method WriteDouble(name: String; value: Double)

 

void WriteDouble(String name, Double value)

 

Sub WriteDouble(name As String, value As Double)

Parameters:

  • name:
  • value:

WriteEnum

 

method WriteEnum(name: String; value: Enum)

 

void WriteEnum(String name, Enum value)

 

Sub WriteEnum(name As String, value As Enum)

Parameters:

  • name:
  • value:

WriteEnvelopeHeader

 

method WriteEnvelopeHeader(envelope: MessageEnvelope; stream: Stream)

 

void WriteEnvelopeHeader(MessageEnvelope envelope, Stream stream)

 

Sub WriteEnvelopeHeader(envelope As MessageEnvelope, stream As Stream)

Parameters:

  • envelope:
  • stream:

WriteException

 

method WriteException(exception: Exception)

 

void WriteException(Exception exception)

 

Sub WriteException(exception As Exception)

Parameters:

  • exception:

WriteGuid

 

method WriteGuid(name: String; value: Guid)

 

void WriteGuid(String name, Guid value)

 

Sub WriteGuid(name As String, value As Guid)

Parameters:

  • name:
  • value:

WriteInt32

 

method WriteInt32(name: String; value: Int32)

 

void WriteInt32(String name, Int32 value)

 

Sub WriteInt32(name As String, value As Int32)

Parameters:

  • name:
  • value:

WriteInt64

 

method WriteInt64(name: String; value: Int64)

 

void WriteInt64(String name, Int64 value)

 

Sub WriteInt64(name As String, value As Int64)

Parameters:

  • name:
  • value:

WriteToStream

 

method WriteToStream(stream: Stream)

 

void WriteToStream(Stream stream)

 

Sub WriteToStream(stream As Stream)

Parameters:

  • stream:

WriteUtf8String

 

method WriteUtf8String(name: String; value: String)

 

void WriteUtf8String(String name, String value)

 

Sub WriteUtf8String(name As String, value As String)

Parameters:

  • name:
  • value:

WriteVariant

 

method WriteVariant(name: String; value: Object)

 

void WriteVariant(String name, Object value)

 

Sub WriteVariant(name As String, value As Object)

Parameters:

  • name:
  • value:

WriteWideString

 

method WriteWideString(name: String; value: String)

 

void WriteWideString(String name, String value)

 

Sub WriteWideString(name As String, value As String)

Parameters:

  • name:
  • value:

WriteXml

 

method WriteXml(name: String; value: XmlNode)

 

void WriteXml(String name, XmlNode value)

 

Sub WriteXml(name As String, value As XmlNode)

Parameters:

  • name:
  • value:

 

AfterReadMessageParam

Gets triggered after a parameter was read from the incoming message. You can use this event to inspect the parameter name, type and value.

 

event AfterReadMessageParam: EventHandler<MessageParamEventArgs>;

 

delegate EventHandler<MessageParamEventArgs> AfterReadMessageParam()

 

Event AfterReadMessageParam As EventHandler<MessageParamEventArgs>

AfterUnwrapEnvelopes

 

event AfterUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>;

 

delegate EventHandler<StreamOperationEventArgs> AfterUnwrapEnvelopes()

 

Event AfterUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>

AfterWrapEnvelopes

 

event AfterWrapEnvelopes: EventHandler<StreamOperationEventArgs>;

 

delegate EventHandler<StreamOperationEventArgs> AfterWrapEnvelopes()

 

Event AfterWrapEnvelopes As EventHandler<StreamOperationEventArgs>

BeforeUnwrapEnvelopes

 

event BeforeUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>;

 

delegate EventHandler<StreamOperationEventArgs> BeforeUnwrapEnvelopes()

 

Event BeforeUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>

BeforeWrapEnvelopes

 

event BeforeWrapEnvelopes: EventHandler<StreamOperationEventArgs>;

 

delegate EventHandler<StreamOperationEventArgs> BeforeWrapEnvelopes()

 

Event BeforeWrapEnvelopes As EventHandler<StreamOperationEventArgs>

BeforeWriteMessageParam

Gets triggered before a parameter gets written to the outgoing message. You can use this event to inspect the parameter name, type and value.

 

event BeforeWriteMessageParam: EventHandler<MessageParamEventArgs>;

 

delegate EventHandler<MessageParamEventArgs> BeforeWriteMessageParam()

 

Event BeforeWriteMessageParam As EventHandler<MessageParamEventArgs>

OnFinalizeMessage

Gets triggered when FinalizeMessage method was called to finalize an outgoing message just before it will be actually sent across the wire to the remote system.

 

event OnFinalizeMessage: EventHandler<EventArgs>;

 

delegate EventHandler<EventArgs> OnFinalizeMessage()

 

Event OnFinalizeMessage As EventHandler<EventArgs>

OnInitializeMessage

Gets triggered when InitializeMessage method is called to initialize an outgoing message. You can hook into this event to inspect information such as the service name and message (method) name, as well as the channel that the message is being dispatched through.

 

event OnInitializeMessage: EventHandler<InitMessageEventArgs>;

 

delegate EventHandler<InitMessageEventArgs> OnInitializeMessage()

 

Event OnInitializeMessage As EventHandler<InitMessageEventArgs>

Descendants

See Also