IMessage
Overview
All custom RemObjects Messages must implement the IMessage interface.
Messages are implemented to create and encode requests in a specific format, such as SOAP or Binary, as well as to decode the response. The ultimate responsibility of a class implementing IMessage is to provide a stream which will be communicated to the server by a ClientChannel.
Though custom message implementations typically inherit from the Message, this inheritance is not necessary. Any IMessage implementation can be passed to a Proxy. The IMessage implementation should know how to process the method parameters it is subsequently passed.
Location
- Reference: RemObjects.SDK.dll
- Namespace: RemObjects.SDK
- Ancestry: IDisposable | IMessage
Clear
Should be implemented to clear the contents of the message.
method Clear
void Clear()
Sub Clear()
ClearAttributes
method ClearAttributes(channel: IChannel)
void ClearAttributes(IChannel channel)
Sub ClearAttributes(channel As IChannel)
Parameters:
- channel:
ClientID
Provides access to the ClientID read from the message.
property ClientID: Guid read write;
Guid ClientID { get; set; }
Property ClientID() As Guid
Clone
Should create and return an identical copy of the message.
ContentType
property ContentType: String read;
String ContentType { get; }
ReadOnly Property ContentType() As String
DefaultDispatcherName
Should return the default/recommended dispatcher name for the message type.
property DefaultDispatcherName: String read;
String DefaultDispatcherName { get; }
ReadOnly Property DefaultDispatcherName() As String
FinalizeMessage
Should be implemented to ensure that the message content is complete before sending it by doing any final processing necessary.
This method 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:
GetStream
Creates a new stream with the content of the message.
method GetStream: Stream
Stream GetStream()
Function GetStream() As Stream
InitializeEventMessage (IChannel, String, String)
This method should be implemented by the Message components to initialize an Event message.
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)
This method should be implemented by the Message components to initialize an Exception message.
method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; e: Exception)
void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception e)
Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, e As Exception)
Parameters:
- channel:
- interfaceName:
- messageName:
- e:
InitializeExceptionMessage (IChannel, String, String, String, Exception)
method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; e: Exception)
void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception e)
Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, e As Exception)
Parameters:
- channel:
- libraryName:
- interfaceName:
- messageName:
- e:
InitializeMessage (IChannel, String, String, MessageType)
This method should be implemented by the Message components to initialize a message of the given type.
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)
Should be implemented by the Message components to initialize a Request message.
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)
Should be implemented by the Message components to initialize a Response message.
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:
InterfaceName
Contains the name of the interface or service that is to be or was called on the server.
property InterfaceName: String read;
String InterfaceName { get; }
ReadOnly Property InterfaceName() As String
MessageName
Contains the name of the message (i.e. the method name) that is to be or was called on the server.
property MessageName: String read;
String MessageName { get; }
ReadOnly Property MessageName() As String
MessageType
Contains the Type of message represented by the message instance.
property MessageType: MessageType read;
MessageType MessageType { get; }
ReadOnly Property MessageType() As MessageType
Read
Should be implemented to read an object of the given type from the message.
Note: Several overloads are provided for value types to avoid the boxing/unboxing that would occur if these were serialized via the generic Read/Write methods.
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
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 a 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:
SerializerInstance
property SerializerInstance: Serializer read;
Serializer SerializerInstance { get; }
ReadOnly Property SerializerInstance() As Serializer
SetAttributes
method SetAttributes(channel: IChannel; names: array of String; values: array of String)
void SetAttributes(IChannel channel, String[] names, String[] values)
Sub SetAttributes(channel As IChannel, names As String(), values As String())
Parameters:
- channel:
- names:
- values:
Validate
method Validate(content: String): Boolean
Boolean Validate(String content)
Function Validate(content As String) As Boolean
Parameters:
- content:
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:
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:
ClientID
Provides access to the ClientID read from the message.
property ClientID: Guid read write;
Guid ClientID { get; set; }
Property ClientID() As Guid
ContentType
property ContentType: String read;
String ContentType { get; }
ReadOnly Property ContentType() As String
DefaultDispatcherName
Should return the default/recommended dispatcher name for the message type.
property DefaultDispatcherName: String read;
String DefaultDispatcherName { get; }
ReadOnly Property DefaultDispatcherName() As String
InterfaceName
Contains the name of the interface or service that is to be or was called on the server.
property InterfaceName: String read;
String InterfaceName { get; }
ReadOnly Property InterfaceName() As String
MessageName
Contains the name of the message (i.e. the method name) that is to be or was called on the server.
property MessageName: String read;
String MessageName { get; }
ReadOnly Property MessageName() As String
MessageType
Contains the Type of message represented by the message instance.
property MessageType: MessageType read;
MessageType MessageType { get; }
ReadOnly Property MessageType() As MessageType
SerializerInstance
property SerializerInstance: Serializer read;
Serializer SerializerInstance { get; }
ReadOnly Property SerializerInstance() As Serializer
Clear
Should be implemented to clear the contents of the message.
method Clear
void Clear()
Sub Clear()
ClearAttributes
method ClearAttributes(channel: IChannel)
void ClearAttributes(IChannel channel)
Sub ClearAttributes(channel As IChannel)
Parameters:
- channel:
Clone
Should create and return an identical copy of the message.
FinalizeMessage
Should be implemented to ensure that the message content is complete before sending it by doing any final processing necessary.
This method 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:
GetStream
Creates a new stream with the content of the message.
method GetStream: Stream
Stream GetStream()
Function GetStream() As Stream
InitializeEventMessage (IChannel, String, String)
This method should be implemented by the Message components to initialize an Event message.
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)
This method should be implemented by the Message components to initialize an Exception message.
method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; e: Exception)
void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception e)
Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, e As Exception)
Parameters:
- channel:
- interfaceName:
- messageName:
- e:
InitializeExceptionMessage (IChannel, String, String, String, Exception)
method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; e: Exception)
void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception e)
Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, e As Exception)
Parameters:
- channel:
- libraryName:
- interfaceName:
- messageName:
- e:
InitializeMessage (IChannel, String, String, MessageType)
This method should be implemented by the Message components to initialize a message of the given type.
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)
Should be implemented by the Message components to initialize a Request message.
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)
Should be implemented by the Message components to initialize a Response message.
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:
Read
Should be implemented to read an object of the given type from the message.
Note: Several overloads are provided for value types to avoid the boxing/unboxing that would occur if these were serialized via the generic Read/Write methods.
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
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 a 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:
SetAttributes
method SetAttributes(channel: IChannel; names: array of String; values: array of String)
void SetAttributes(IChannel channel, String[] names, String[] values)
Sub SetAttributes(channel As IChannel, names As String(), values As String())
Parameters:
- channel:
- names:
- values:
Validate
method Validate(content: String): Boolean
Boolean Validate(String content)
Function Validate(content As String) As Boolean
Parameters:
- content:
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:
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:
-
IMessage Interface
- .NET
- Java