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 IMessage interface. Though message components typically descend from the Message class, this is not required, but all custom messages have to implement the IMessage interface.
Location
- Reference: RemObjects.SDK.dll
- Namespace: RemObjects.SDK
- Ancestry: Component | Message
constructor protected
Creates a new instance of the Message class.
This constructor can be called only from a derived class.
constructor
Message()
init()
Sub New()
AddServerExceptionPrefix
// .NET Compact Framework, .NET Core, .NET Standard
property AddServerExceptionPrefix: Boolean read write;
// .NET Framework
[DefaultValue(true)]
property AddServerExceptionPrefix: Boolean read write;
// .NET Compact Framework, .NET Core, .NET Standard
Boolean AddServerExceptionPrefix { get; set; }
// .NET Framework
[DefaultValue(true)]
Boolean AddServerExceptionPrefix { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var AddServerExceptionPrefix: Boolean { get{} set{} }
// .NET Framework
@DefaultValue(true)
var AddServerExceptionPrefix: Boolean { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property AddServerExceptionPrefix() As Boolean
// .NET Framework
<DefaultValue(true)>
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 EventHandler<MessageParamEventArgs>: AfterReadMessageParam!
Event AfterReadMessageParam As EventHandler<MessageParamEventArgs>
AfterUnwrapEnvelopes
event AfterUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> AfterUnwrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: AfterUnwrapEnvelopes!
Event AfterUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>
AfterWrapEnvelopes
event AfterWrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> AfterWrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: AfterWrapEnvelopes!
Event AfterWrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeUnwrapEnvelopes
event BeforeUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> BeforeUnwrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: BeforeUnwrapEnvelopes!
Event BeforeUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeWrapEnvelopes
event BeforeWrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> BeforeWrapEnvelopes()
__event 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 EventHandler<MessageParamEventArgs>: BeforeWriteMessageParam!
Event BeforeWriteMessageParam As EventHandler<MessageParamEventArgs>
CanRemapParameters protected
method CanRemapParameters: Boolean
Boolean CanRemapParameters()
func CanRemapParameters() -> Boolean
Function CanRemapParameters() As Boolean
CheckForEnvelope protected
method CheckForEnvelope(stream: Stream; out envelopeName: String): Boolean
Boolean CheckForEnvelope(Stream stream, out String envelopeName)
func CheckForEnvelope(_ stream: Stream, _ envelopeName: inout String) -> Boolean
Function CheckForEnvelope(stream As Stream, <OutAttribute> ByRef envelopeName As String) As Boolean
Parameters:
- stream:
- envelopeName:
Clear
Clears all internal data structures and prepare the class to handle the processing of a new message.
method Clear
void Clear()
func Clear()
Sub Clear()
ClearAttributes
Clears internally set serializer options based on the attribute values and/or HTTP headers.
method ClearAttributes(channel: IChannel)
void ClearAttributes(IChannel channel)
func ClearAttributes(_ channel: IChannel)
Sub ClearAttributes(channel As IChannel)
Parameters:
- channel: Communication 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; }
var ClientID: Guid { get{} set{} }
Property ClientID() As Guid
Clone
Creates and returns an identical copy of the message.
method Clone: IMessage
IMessage Clone()
func Clone() -> IMessage
Function Clone() As IMessage
CloneFrom protected
Copies properties values from the provided instance to the current instance.
method CloneFrom(message: Message)
void CloneFrom(Message message)
func CloneFrom(_ message: Message)
Sub CloneFrom(message As Message)
Parameters:
- message: Message to clone
ContentType
Gets message's content type.
property ContentType: String read write;
String ContentType { get; set; }
var ContentType: String { get{} set{} }
Property ContentType() As String
CreateException protected
method CreateException(exceptionName: String; message: String): Exception
Exception CreateException(String exceptionName, String message)
func CreateException(_ exceptionName: String, _ message: String) -> Exception
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; }
var DefaultDispatcherName: String { get{} }
ReadOnly Property DefaultDispatcherName() As String
Dispose protected
method Dispose(disposing: Boolean)
void Dispose(Boolean disposing)
func Dispose(_ disposing: Boolean)
Sub Dispose(disposing As Boolean)
Parameters:
- disposing:
Envelopes
property Envelopes: MessageEnvelopes read;
MessageEnvelopes Envelopes { get; }
var Envelopes: MessageEnvelopes { get{} }
ReadOnly Property 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()
func FinalizeMessage()
Sub FinalizeMessage()
FinalizeRequest
Finalizes the data request serialization.
method FinalizeRequest(channel: IRequest)
void FinalizeRequest(IRequest channel)
func FinalizeRequest(_ channel: IRequest)
Sub FinalizeRequest(channel As IRequest)
Parameters:
- channel: Communication channel
GetExceptionMessage protected
method GetExceptionMessage(exception: Exception): String
String GetExceptionMessage(Exception exception)
func GetExceptionMessage(_ exception: Exception) -> String
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()
func GetStream() -> Stream
Function GetStream() As Stream
HasEnvelope
class method HasEnvelope(data: array of Byte): Boolean
static Boolean HasEnvelope(Byte[] data)
static func HasEnvelope(_ data: Byte...) -> Boolean
Shared Function HasEnvelope(data As Byte()) As Boolean
Parameters:
- data:
InitializeEventMessage (IChannel, String, String)
Initializes new event message for interface interfaceName with message name messageName on channel channel.
method InitializeEventMessage(channel: IChannel; interfaceName: String; messageName: String)
void InitializeEventMessage(IChannel channel, String interfaceName, String messageName)
func InitializeEventMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)
Sub InitializeEventMessage(channel As IChannel, interfaceName As String, messageName As String)
Parameters:
- channel: Communication channel that will be used to send the event message
- interfaceName: Communication channel that will be used to send the event message
- messageName: Message name. Corresponds to the name of the service method being executed
InitializeEventMessage (IChannel, String, String, String)
Initializes new event message for interface interfaceName with message name messageName on channel channel.
method InitializeEventMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)
void InitializeEventMessage(IChannel channel, String libraryName, String interfaceName, String messageName)
func InitializeEventMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)
Sub InitializeEventMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)
Parameters:
- channel: Communication channel that will be used to send the event message
- libraryName: RODL library name
- interfaceName: Communication channel that will be used to send the event message
- messageName: Message name. Corresponds to the name of the service method being executed
InitializeExceptionMessage (IChannel, String, String, Exception)
Should be implemented by Message components to initialize a Exception message.
method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; exception: Exception)
void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception exception)
func InitializeExceptionMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ exception: Exception)
Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, exception As Exception)
Parameters:
- channel: Communication channel that will be used to send the exception message
- interfaceName: A name of the interface (i.e. the service).
- messageName: Message name. Corresponds to the name of the service method being executed
- exception: Exception that should be serialized and sent to the client application
InitializeExceptionMessage (IChannel, String, String, String, Exception)
Should be implemented by Message components to initialize a Exception message.
method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; exception: Exception)
void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception exception)
func InitializeExceptionMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String, _ exception: Exception)
Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, exception As Exception)
Parameters:
- channel: Communication channel that will be used to send the exception message
- libraryName: RODL library name
- interfaceName: A name of the interface (i.e. the service).
- messageName: Message name. Corresponds to the name of the service method being executed
- exception: Exception that should be serialized and sent to the client application
InitializeMessage (IChannel, String, String, MessageType)
Initializes message of requested type for interface interfaceName with message name messageName on channel channel.
method InitializeMessage(channel: IChannel; interfaceName: String; messageName: String; messageType: MessageType)
void InitializeMessage(IChannel channel, String interfaceName, String messageName, MessageType messageType)
func InitializeMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ messageType: MessageType)
Sub InitializeMessage(channel As IChannel, interfaceName As String, messageName As String, messageType As MessageType)
Parameters:
- channel: Communication channel
- interfaceName: Interface name
- messageName: Message name
- messageType: Message type (event, exception etc)
InitializeMessage (IChannel, String, String, String, MessageType)
Initializes message of requested type for interface interfaceName with message name messageName on channel channel.
method InitializeMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; messageType: MessageType)
void InitializeMessage(IChannel channel, String libraryName, String interfaceName, String messageName, MessageType messageType)
func InitializeMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String, _ messageType: MessageType)
Sub InitializeMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, messageType As MessageType)
Parameters:
- channel: Communication channel
- libraryName: Library name
- interfaceName: Interface name
- messageName: Message name
- messageType: Message type (event, exception etc)
InitializeMessageEx
Initializes message of requested type on channel channel.
method InitializeMessageEx(channel: IChannel; messageType: MessageType)
void InitializeMessageEx(IChannel channel, MessageType messageType)
func InitializeMessageEx(_ channel: IChannel, _ messageType: MessageType)
Sub InitializeMessageEx(channel As IChannel, messageType As MessageType)
Parameters:
- channel: Communication channel
- messageType: Message type (event, exception etc)
InitializeRead
method InitializeRead(channel: IChannel)
void InitializeRead(IChannel channel)
func InitializeRead(_ channel: IChannel)
Sub InitializeRead(channel As IChannel)
Parameters:
- channel: Communication channnel
InitializeRequest
Sets additional options of the communication channel and data serializer.
method InitializeRequest(channel: IRequest)
void InitializeRequest(IRequest channel)
func InitializeRequest(_ channel: IRequest)
Sub InitializeRequest(channel As IRequest)
Parameters:
- channel: Communication channnel
InitializeRequestMessage (IChannel, String, String)
Should be implemented by Message components to initialize a Request message.
method InitializeRequestMessage(channel: IChannel; interfaceName: String; messageName: String)
void InitializeRequestMessage(IChannel channel, String interfaceName, String messageName)
func InitializeRequestMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)
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)
func InitializeRequestMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)
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 Message components to initialize a Response message.
method InitializeResponseMessage(channel: IChannel; interfaceName: String; messageName: String)
void InitializeResponseMessage(IChannel channel, String interfaceName, String messageName)
func InitializeResponseMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)
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)
func InitializeResponseMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)
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()
func InitializeSerializer()
Sub InitializeSerializer()
InterfaceName
Contains the name of the interface (i.e. the service) that is being called (read-only).
// .NET Compact Framework, .NET Core, .NET Standard
property InterfaceName: String read write;
// .NET Framework
[DefaultValue(nil)]
property InterfaceName: String read write;
// .NET Compact Framework, .NET Core, .NET Standard
String InterfaceName { get; set; }
// .NET Framework
[DefaultValue(null)]
String InterfaceName { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var InterfaceName: String { get{} set{} }
// .NET Framework
@DefaultValue(nil)
var InterfaceName: String { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property InterfaceName() As String
// .NET Framework
<DefaultValue(Nothing)>
Property InterfaceName() As String
IsValidMessage
property IsValidMessage: Boolean read;
Boolean IsValidMessage { get; }
var IsValidMessage: Boolean { get{} }
ReadOnly Property IsValidMessage() As Boolean
MaxStringSize
// .NET Compact Framework, .NET Core, .NET Standard
property MaxStringSize: Int32 read write;
// .NET Framework
[DefaultValue(-1)]
property MaxStringSize: Int32 read write;
// .NET Compact Framework, .NET Core, .NET Standard
Int32 MaxStringSize { get; set; }
// .NET Framework
[DefaultValue(-1)]
Int32 MaxStringSize { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var MaxStringSize: Int32 { get{} set{} }
// .NET Framework
@DefaultValue(-1)
var MaxStringSize: Int32 { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property MaxStringSize() As Int32
// .NET Framework
<DefaultValue(-1)>
Property MaxStringSize() As Int32
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)
static func MessageMatchingTargetUri(_ uri: String) -> IMessage
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)
static func MessageMatchingTargetUri(_ uri: Uri) -> IMessage
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).
// .NET Compact Framework, .NET Core, .NET Standard
property MessageName: String read write;
// .NET Framework
[DefaultValue(nil)]
property MessageName: String read write;
// .NET Compact Framework, .NET Core, .NET Standard
String MessageName { get; set; }
// .NET Framework
[DefaultValue(null)]
String MessageName { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var MessageName: String { get{} set{} }
// .NET Framework
@DefaultValue(nil)
var MessageName: String { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property MessageName() As String
// .NET Framework
<DefaultValue(Nothing)>
Property MessageName() As String
MessageType
Contains the Type of message represented by the message instance.
property MessageType: MessageType read write;
MessageType MessageType { get; set; }
var 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 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 EventHandler<InitMessageEventArgs>: OnInitializeMessage!
Event OnInitializeMessage As EventHandler<InitMessageEventArgs>
ProcessException protected
method ProcessException
void ProcessException()
func ProcessException()
Sub ProcessException()
Read
Calls the appropriate method for reading the given Type (such as ReadString or ReadInt32). If the type is unsupported, an exception is raised. Objects can be written to the Serializer using the Write method. You will usually not need to override this method when implementing a custom Serializer.
method Read(name: String; type: Type; format: StreamingFormat): Object
Object Read(String name, Type type, StreamingFormat format)
func Read(_ name: String, _ type: Type, _ format: StreamingFormat) -> Object
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)
func ReadAnsiString(_ name: String) -> String
Function ReadAnsiString(name As String) As String
Parameters:
- name:
ReadBoolean
method ReadBoolean(name: String): Boolean
Boolean ReadBoolean(String name)
func ReadBoolean(_ name: String) -> Boolean
Function ReadBoolean(name As String) As Boolean
Parameters:
- name:
ReadCurrency
method ReadCurrency(name: String): Decimal
Decimal ReadCurrency(String name)
func ReadCurrency(_ name: String) -> Decimal
Function ReadCurrency(name As String) As Decimal
Parameters:
- name:
ReadDateTime
method ReadDateTime(name: String): DateTime
DateTime ReadDateTime(String name)
func ReadDateTime(_ name: String) -> DateTime
Function ReadDateTime(name As String) As DateTime
Parameters:
- name:
ReadDecimal
method ReadDecimal(name: String): Decimal
Decimal ReadDecimal(String name)
func ReadDecimal(_ name: String) -> Decimal
Function ReadDecimal(name As String) As Decimal
Parameters:
- name:
ReadDouble
method ReadDouble(name: String): Double
Double ReadDouble(String name)
func ReadDouble(_ name: String) -> Double
Function ReadDouble(name As String) As Double
Parameters:
- name:
ReadEnum
method ReadEnum(name: String; type: Type): Enum
Enum ReadEnum(String name, Type type)
func ReadEnum(_ name: String, _ type: Type) -> Enum
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()
func ReadException() -> Exception
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)
func ReadFromStream(_ stream: Stream)
Sub ReadFromStream(stream As Stream)
Parameters:
- stream:
ReadGuid
method ReadGuid(name: String): Guid
Guid ReadGuid(String name)
func ReadGuid(_ name: String) -> Guid
Function ReadGuid(name As String) As Guid
Parameters:
- name:
ReadInt32
Reads Int32
value.
method ReadInt32(name: String): Int32
Int32 ReadInt32(String name)
func ReadInt32(_ name: String) -> Int32
Function ReadInt32(name As String) As Int32
Parameters:
- name:
ReadInt64
Reads Int64
value.
method ReadInt64(name: String): Int64
Int64 ReadInt64(String name)
func ReadInt64(_ name: String) -> Int64
Function ReadInt64(name As String) As Int64
Parameters:
- name:
ReadNullableBoolean
method ReadNullableBoolean(name: String): nullable Boolean
Boolean? ReadNullableBoolean(String name)
func ReadNullableBoolean(_ name: String) -> Boolean!
Function ReadNullableBoolean(name As String) As Boolean?
Parameters:
- name:
ReadNullableCurrency
method ReadNullableCurrency(name: String): nullable Decimal
Decimal? ReadNullableCurrency(String name)
func ReadNullableCurrency(_ name: String) -> Decimal!
Function ReadNullableCurrency(name As String) As Decimal?
Parameters:
- name:
ReadNullableDateTime
method ReadNullableDateTime(name: String): nullable DateTime
DateTime? ReadNullableDateTime(String name)
func ReadNullableDateTime(_ name: String) -> DateTime!
Function ReadNullableDateTime(name As String) As DateTime?
Parameters:
- name:
ReadNullableDecimal
method ReadNullableDecimal(name: String): nullable Decimal
Decimal? ReadNullableDecimal(String name)
func ReadNullableDecimal(_ name: String) -> Decimal!
Function ReadNullableDecimal(name As String) As Decimal?
Parameters:
- name:
ReadNullableDouble
method ReadNullableDouble(name: String): nullable Double
Double? ReadNullableDouble(String name)
func ReadNullableDouble(_ name: String) -> Double!
Function ReadNullableDouble(name As String) As Double?
Parameters:
- name:
ReadNullableEnum
method ReadNullableEnum(name: String; type: Type): nullable Enum
Enum? ReadNullableEnum(String name, Type type)
func ReadNullableEnum(_ name: String, _ type: Type) -> Enum?
Function ReadNullableEnum(name As String, type As Type) As Enum?
Parameters:
- name:
- type:
ReadNullableGuid
method ReadNullableGuid(name: String): nullable Guid
Guid? ReadNullableGuid(String name)
func ReadNullableGuid(_ name: String) -> Guid!
Function ReadNullableGuid(name As String) As Guid?
Parameters:
- name:
ReadNullableInt32
method ReadNullableInt32(name: String): nullable Int32
Int32? ReadNullableInt32(String name)
func ReadNullableInt32(_ name: String) -> Int32!
Function ReadNullableInt32(name As String) As Int32?
Parameters:
- name:
ReadNullableInt64
method ReadNullableInt64(name: String): nullable Int64
Int64? ReadNullableInt64(String name)
func ReadNullableInt64(_ name: String) -> Int64!
Function ReadNullableInt64(name As String) As Int64?
Parameters:
- name:
ReadUtf8String
method ReadUtf8String(name: String): String
String ReadUtf8String(String name)
func ReadUtf8String(_ name: String) -> String
Function ReadUtf8String(name As String) As String
Parameters:
- name:
ReadVariant
method ReadVariant(name: String): Object
Object ReadVariant(String name)
func ReadVariant(_ name: String) -> Object
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)
func ReadWideString(_ name: String) -> String
Function ReadWideString(name As String) As String
Parameters:
- name:
ReadXml
method ReadXml(name: String): XmlNode
XmlNode ReadXml(String name)
func ReadXml(_ name: String) -> XmlNode
Function ReadXml(name As String) As XmlNode
Parameters:
- name:
RemapParameters protected
method RemapParameters(parameters: array of String)
void RemapParameters(String[] parameters)
func RemapParameters(_ parameters: String...)
Sub RemapParameters(parameters As String())
Parameters:
- parameters:
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; }
var SerializerInstance: Serializer { get{} set{} }
Property SerializerInstance() As Serializer
ServerExceptionPrefix
// .NET Compact Framework, .NET Core, .NET Standard
property ServerExceptionPrefix: String read write;
// .NET Framework
[DefaultValue('An exception occurred on the server: ')]
property ServerExceptionPrefix: String read write;
// .NET Compact Framework, .NET Core, .NET Standard
String ServerExceptionPrefix { get; set; }
// .NET Framework
[DefaultValue(\"An exception occurred on the server: \")]
String ServerExceptionPrefix { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var ServerExceptionPrefix: String { get{} set{} }
// .NET Framework
@DefaultValue(\"An exception occurred on the server: \")
var ServerExceptionPrefix: String { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property ServerExceptionPrefix() As String
// .NET Framework
<DefaultValue(\"An exception occurred on the server: \")>
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)
func SetAttributes(_ channel: IChannel, _ attributeNames: String..., _ attributeValues: String...)
Sub SetAttributes(channel As IChannel, attributeNames As String(), attributeValues As String())
Parameters:
- channel:
- attributeNames:
- attributeValues:
TriggerAfterReadMessageParam (String, Object) protected
method TriggerAfterReadMessageParam(name: String; parameter: Object)
void TriggerAfterReadMessageParam(String name, Object parameter)
func TriggerAfterReadMessageParam(_ name: String, _ parameter: Object)
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)
func TriggerAfterReadMessageParam(_ name: String, _ parameter: Object, _ 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)
func TriggerAfterReadMessageParam(_ name: String, _ parameter: Object, _ type: Type, _ format: StreamingFormat)
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)
func TriggerAfterUnwrapEnvelopes(_ stream: Stream)
Sub TriggerAfterUnwrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerAfterWrapEnvelopes protected
method TriggerAfterWrapEnvelopes(stream: Stream)
void TriggerAfterWrapEnvelopes(Stream stream)
func TriggerAfterWrapEnvelopes(_ stream: Stream)
Sub TriggerAfterWrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeUnwrapEnvelopes protected
method TriggerBeforeUnwrapEnvelopes(stream: Stream)
void TriggerBeforeUnwrapEnvelopes(Stream stream)
func TriggerBeforeUnwrapEnvelopes(_ stream: Stream)
Sub TriggerBeforeUnwrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeWrapEnvelopes protected
method TriggerBeforeWrapEnvelopes(stream: Stream)
void TriggerBeforeWrapEnvelopes(Stream stream)
func 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)
func TriggerBeforeWriteMessageParam(_ name: String, _ parameter: Object)
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)
func TriggerBeforeWriteMessageParam(_ name: String, _ parameter: Object, _ 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)
func TriggerBeforeWriteMessageParam(_ name: String, _ parameter: Object, _ type: Type, _ format: StreamingFormat)
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()
func 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)
func TriggerOnInitializeMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ 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)
func UnwrapEnvelopes(_ stream: Stream) -> Stream
Function UnwrapEnvelopes(stream As Stream) As Stream
Parameters:
- stream:
Validate
method Validate(content: String): Boolean
Boolean Validate(String content)
func Validate(_ content: String) -> Boolean
Function Validate(content As String) As Boolean
Parameters:
- content:
WrapEnvelopes protected
method WrapEnvelopes(stream: Stream): Stream
Stream WrapEnvelopes(Stream stream)
func WrapEnvelopes(_ stream: 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)
func Write(_ name: String, _ value: Object, _ type: Type, _ format: StreamingFormat)
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)
func WriteAnsiString(_ name: String, _ value: String)
Sub WriteAnsiString(name As String, value As String)
Parameters:
- name:
- value:
WriteBoolean
method WriteBoolean(name: String; value: Boolean)
void WriteBoolean(String name, Boolean value)
func WriteBoolean(_ name: String, _ value: Boolean)
Sub WriteBoolean(name As String, value As Boolean)
Parameters:
- name:
- value:
WriteCurrency
method WriteCurrency(name: String; value: Decimal)
void WriteCurrency(String name, Decimal value)
func WriteCurrency(_ name: String, _ value: Decimal)
Sub WriteCurrency(name As String, value As Decimal)
Parameters:
- name:
- value:
WriteDateTime
method WriteDateTime(name: String; value: DateTime)
void WriteDateTime(String name, DateTime value)
func WriteDateTime(_ name: String, _ value: DateTime)
Sub WriteDateTime(name As String, value As DateTime)
Parameters:
- name:
- value:
WriteDecimal
method WriteDecimal(name: String; value: Decimal)
void WriteDecimal(String name, Decimal value)
func WriteDecimal(_ name: String, _ value: Decimal)
Sub WriteDecimal(name As String, value As Decimal)
Parameters:
- name:
- value:
WriteDouble
method WriteDouble(name: String; value: Double)
void WriteDouble(String name, Double value)
func WriteDouble(_ name: String, _ value: Double)
Sub WriteDouble(name As String, value As Double)
Parameters:
- name:
- value:
WriteEnum
method WriteEnum(name: String; value: Enum)
void WriteEnum(String name, Enum value)
func WriteEnum(_ name: String, _ value: Enum)
Sub WriteEnum(name As String, value As Enum)
Parameters:
- name:
- value:
WriteEnvelopeHeader
method WriteEnvelopeHeader(envelope: MessageEnvelope; stream: Stream)
void WriteEnvelopeHeader(MessageEnvelope envelope, Stream stream)
func WriteEnvelopeHeader(_ envelope: MessageEnvelope, _ stream: Stream)
Sub WriteEnvelopeHeader(envelope As MessageEnvelope, stream As Stream)
Parameters:
- envelope:
- stream:
WriteException
method WriteException(exception: Exception)
void WriteException(Exception exception)
func WriteException(_ exception: Exception)
Sub WriteException(exception As Exception)
Parameters:
- exception:
WriteGuid
method WriteGuid(name: String; value: Guid)
void WriteGuid(String name, Guid value)
func WriteGuid(_ name: String, _ value: Guid)
Sub WriteGuid(name As String, value As Guid)
Parameters:
- name:
- value:
WriteInt32
method WriteInt32(name: String; value: Int32)
void WriteInt32(String name, Int32 value)
func WriteInt32(_ name: String, _ value: Int32)
Sub WriteInt32(name As String, value As Int32)
Parameters:
- name:
- value:
WriteInt64
method WriteInt64(name: String; value: Int64)
void WriteInt64(String name, Int64 value)
func WriteInt64(_ name: String, _ value: Int64)
Sub WriteInt64(name As String, value As Int64)
Parameters:
- name:
- value:
WriteNullableBoolean
method WriteNullableBoolean(name: String; value: Nullable<Boolean>)
void WriteNullableBoolean(String name, Nullable<Boolean> value)
func WriteNullableBoolean(_ name: String, _ value: Nullable<Boolean>)
Sub WriteNullableBoolean(name As String, value As Nullable<Boolean>)
Parameters:
- name:
- value:
WriteNullableCurrency
method WriteNullableCurrency(name: String; value: Nullable<Decimal>)
void WriteNullableCurrency(String name, Nullable<Decimal> value)
func WriteNullableCurrency(_ name: String, _ value: Nullable<Decimal>)
Sub WriteNullableCurrency(name As String, value As Nullable<Decimal>)
Parameters:
- name:
- value:
WriteNullableDateTime
method WriteNullableDateTime(name: String; value: Nullable<DateTime>)
void WriteNullableDateTime(String name, Nullable<DateTime> value)
func WriteNullableDateTime(_ name: String, _ value: Nullable<DateTime>)
Sub WriteNullableDateTime(name As String, value As Nullable<DateTime>)
Parameters:
- name:
- value:
WriteNullableDecimal
method WriteNullableDecimal(name: String; value: Nullable<Decimal>)
void WriteNullableDecimal(String name, Nullable<Decimal> value)
func WriteNullableDecimal(_ name: String, _ value: Nullable<Decimal>)
Sub WriteNullableDecimal(name As String, value As Nullable<Decimal>)
Parameters:
- name:
- value:
WriteNullableDouble
method WriteNullableDouble(name: String; value: Nullable<Double>)
void WriteNullableDouble(String name, Nullable<Double> value)
func WriteNullableDouble(_ name: String, _ value: Nullable<Double>)
Sub WriteNullableDouble(name As String, value As Nullable<Double>)
Parameters:
- name:
- value:
WriteNullableEnum
method WriteNullableEnum(name: String; value: nullable Enum)
void WriteNullableEnum(String name, Enum? value)
func WriteNullableEnum(_ name: String, _ value: Enum?)
Sub WriteNullableEnum(name As String, value As Enum?)
Parameters:
- name:
- value:
WriteNullableGuid
method WriteNullableGuid(name: String; value: Nullable<Guid>)
void WriteNullableGuid(String name, Nullable<Guid> value)
func WriteNullableGuid(_ name: String, _ value: Nullable<Guid>)
Sub WriteNullableGuid(name As String, value As Nullable<Guid>)
Parameters:
- name:
- value:
WriteNullableInt32
method WriteNullableInt32(name: String; value: Nullable<Int32>)
void WriteNullableInt32(String name, Nullable<Int32> value)
func WriteNullableInt32(_ name: String, _ value: Nullable<Int32>)
Sub WriteNullableInt32(name As String, value As Nullable<Int32>)
Parameters:
- name:
- value:
WriteNullableInt64
method WriteNullableInt64(name: String; value: Nullable<Int64>)
void WriteNullableInt64(String name, Nullable<Int64> value)
func WriteNullableInt64(_ name: String, _ value: Nullable<Int64>)
Sub WriteNullableInt64(name As String, value As Nullable<Int64>)
Parameters:
- name:
- value:
WriteToStream
method WriteToStream(stream: Stream)
void WriteToStream(Stream stream)
func WriteToStream(_ stream: Stream)
Sub WriteToStream(stream As Stream)
Parameters:
- stream:
WriteUtf8String
method WriteUtf8String(name: String; value: String)
void WriteUtf8String(String name, String value)
func WriteUtf8String(_ name: String, _ value: String)
Sub WriteUtf8String(name As String, value As String)
Parameters:
- name:
- value:
WriteVariant
method WriteVariant(name: String; value: Object)
void WriteVariant(String name, Object value)
func WriteVariant(_ name: String, _ value: Object)
Sub WriteVariant(name As String, value As Object)
Parameters:
- name:
- value:
WriteWideString
method WriteWideString(name: String; value: String)
void WriteWideString(String name, String value)
func WriteWideString(_ name: String, _ value: String)
Sub WriteWideString(name As String, value As String)
Parameters:
- name:
- value:
WriteXml
method WriteXml(name: String; value: XmlNode)
void WriteXml(String name, XmlNode value)
func WriteXml(_ name: String, _ value: XmlNode)
Sub WriteXml(name As String, value As XmlNode)
Parameters:
- name:
- value:
AddServerExceptionPrefix
// .NET Compact Framework, .NET Core, .NET Standard
property AddServerExceptionPrefix: Boolean read write;
// .NET Framework
[DefaultValue(true)]
property AddServerExceptionPrefix: Boolean read write;
// .NET Compact Framework, .NET Core, .NET Standard
Boolean AddServerExceptionPrefix { get; set; }
// .NET Framework
[DefaultValue(true)]
Boolean AddServerExceptionPrefix { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var AddServerExceptionPrefix: Boolean { get{} set{} }
// .NET Framework
@DefaultValue(true)
var AddServerExceptionPrefix: Boolean { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property AddServerExceptionPrefix() As Boolean
// .NET Framework
<DefaultValue(true)>
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; }
var ClientID: Guid { get{} set{} }
Property ClientID() As Guid
ContentType
Gets message's content type.
property ContentType: String read write;
String ContentType { get; set; }
var ContentType: String { get{} set{} }
Property ContentType() As String
DefaultDispatcherName
Returns the default/recommended dispatcher name for the message type.
property DefaultDispatcherName: String read;
String DefaultDispatcherName { get; }
var DefaultDispatcherName: String { get{} }
ReadOnly Property DefaultDispatcherName() As String
Envelopes
property Envelopes: MessageEnvelopes read;
MessageEnvelopes Envelopes { get; }
var Envelopes: MessageEnvelopes { get{} }
ReadOnly Property Envelopes() As MessageEnvelopes
InterfaceName
Contains the name of the interface (i.e. the service) that is being called (read-only).
// .NET Compact Framework, .NET Core, .NET Standard
property InterfaceName: String read write;
// .NET Framework
[DefaultValue(nil)]
property InterfaceName: String read write;
// .NET Compact Framework, .NET Core, .NET Standard
String InterfaceName { get; set; }
// .NET Framework
[DefaultValue(null)]
String InterfaceName { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var InterfaceName: String { get{} set{} }
// .NET Framework
@DefaultValue(nil)
var InterfaceName: String { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property InterfaceName() As String
// .NET Framework
<DefaultValue(Nothing)>
Property InterfaceName() As String
IsValidMessage
property IsValidMessage: Boolean read;
Boolean IsValidMessage { get; }
var IsValidMessage: Boolean { get{} }
ReadOnly Property IsValidMessage() As Boolean
MaxStringSize
// .NET Compact Framework, .NET Core, .NET Standard
property MaxStringSize: Int32 read write;
// .NET Framework
[DefaultValue(-1)]
property MaxStringSize: Int32 read write;
// .NET Compact Framework, .NET Core, .NET Standard
Int32 MaxStringSize { get; set; }
// .NET Framework
[DefaultValue(-1)]
Int32 MaxStringSize { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var MaxStringSize: Int32 { get{} set{} }
// .NET Framework
@DefaultValue(-1)
var MaxStringSize: Int32 { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property MaxStringSize() As Int32
// .NET Framework
<DefaultValue(-1)>
Property MaxStringSize() As Int32
MessageName
Contains the name of the message (i.e. the method) that is being called (read-only).
// .NET Compact Framework, .NET Core, .NET Standard
property MessageName: String read write;
// .NET Framework
[DefaultValue(nil)]
property MessageName: String read write;
// .NET Compact Framework, .NET Core, .NET Standard
String MessageName { get; set; }
// .NET Framework
[DefaultValue(null)]
String MessageName { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var MessageName: String { get{} set{} }
// .NET Framework
@DefaultValue(nil)
var MessageName: String { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property MessageName() As String
// .NET Framework
<DefaultValue(Nothing)>
Property MessageName() As String
MessageType
Contains the Type of message represented by the message instance.
property MessageType: MessageType read write;
MessageType MessageType { get; set; }
var 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; }
var SerializerInstance: Serializer { get{} set{} }
Property SerializerInstance() As Serializer
ServerExceptionPrefix
// .NET Compact Framework, .NET Core, .NET Standard
property ServerExceptionPrefix: String read write;
// .NET Framework
[DefaultValue('An exception occurred on the server: ')]
property ServerExceptionPrefix: String read write;
// .NET Compact Framework, .NET Core, .NET Standard
String ServerExceptionPrefix { get; set; }
// .NET Framework
[DefaultValue(\"An exception occurred on the server: \")]
String ServerExceptionPrefix { get; set; }
// .NET Compact Framework, .NET Core, .NET Standard
var ServerExceptionPrefix: String { get{} set{} }
// .NET Framework
@DefaultValue(\"An exception occurred on the server: \")
var ServerExceptionPrefix: String { get{} set{} }
// .NET Compact Framework, .NET Core, .NET Standard
Property ServerExceptionPrefix() As String
// .NET Framework
<DefaultValue(\"An exception occurred on the server: \")>
Property ServerExceptionPrefix() As String
HasEnvelope
class method HasEnvelope(data: array of Byte): Boolean
static Boolean HasEnvelope(Byte[] data)
static func HasEnvelope(_ data: Byte...) -> Boolean
Shared Function HasEnvelope(data As 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)
static func MessageMatchingTargetUri(_ uri: String) -> IMessage
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)
static func MessageMatchingTargetUri(_ uri: Uri) -> IMessage
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()
init()
Sub New()
CanRemapParameters protected
method CanRemapParameters: Boolean
Boolean CanRemapParameters()
func CanRemapParameters() -> Boolean
Function CanRemapParameters() As Boolean
CheckForEnvelope protected
method CheckForEnvelope(stream: Stream; out envelopeName: String): Boolean
Boolean CheckForEnvelope(Stream stream, out String envelopeName)
func CheckForEnvelope(_ stream: Stream, _ envelopeName: inout String) -> Boolean
Function CheckForEnvelope(stream As Stream, <OutAttribute> ByRef envelopeName As String) As Boolean
Parameters:
- stream:
- envelopeName:
Clear
Clears all internal data structures and prepare the class to handle the processing of a new message.
method Clear
void Clear()
func Clear()
Sub Clear()
ClearAttributes
Clears internally set serializer options based on the attribute values and/or HTTP headers.
method ClearAttributes(channel: IChannel)
void ClearAttributes(IChannel channel)
func ClearAttributes(_ channel: IChannel)
Sub ClearAttributes(channel As IChannel)
Parameters:
- channel: Communication channel
Clone
Creates and returns an identical copy of the message.
method Clone: IMessage
IMessage Clone()
func Clone() -> IMessage
Function Clone() As IMessage
CloneFrom protected
Copies properties values from the provided instance to the current instance.
method CloneFrom(message: Message)
void CloneFrom(Message message)
func CloneFrom(_ message: Message)
Sub CloneFrom(message As Message)
Parameters:
- message: Message to clone
CreateException protected
method CreateException(exceptionName: String; message: String): Exception
Exception CreateException(String exceptionName, String message)
func CreateException(_ exceptionName: String, _ message: String) -> Exception
Function CreateException(exceptionName As String, message As String) As Exception
Parameters:
- exceptionName:
- message:
Dispose protected
method Dispose(disposing: Boolean)
void Dispose(Boolean disposing)
func Dispose(_ disposing: Boolean)
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()
func FinalizeMessage()
Sub FinalizeMessage()
FinalizeRequest
Finalizes the data request serialization.
method FinalizeRequest(channel: IRequest)
void FinalizeRequest(IRequest channel)
func FinalizeRequest(_ channel: IRequest)
Sub FinalizeRequest(channel As IRequest)
Parameters:
- channel: Communication channel
GetExceptionMessage protected
method GetExceptionMessage(exception: Exception): String
String GetExceptionMessage(Exception exception)
func GetExceptionMessage(_ exception: Exception) -> String
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()
func GetStream() -> Stream
Function GetStream() As Stream
InitializeEventMessage (IChannel, String, String)
Initializes new event message for interface interfaceName with message name messageName on channel channel.
method InitializeEventMessage(channel: IChannel; interfaceName: String; messageName: String)
void InitializeEventMessage(IChannel channel, String interfaceName, String messageName)
func InitializeEventMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)
Sub InitializeEventMessage(channel As IChannel, interfaceName As String, messageName As String)
Parameters:
- channel: Communication channel that will be used to send the event message
- interfaceName: Communication channel that will be used to send the event message
- messageName: Message name. Corresponds to the name of the service method being executed
InitializeEventMessage (IChannel, String, String, String)
Initializes new event message for interface interfaceName with message name messageName on channel channel.
method InitializeEventMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)
void InitializeEventMessage(IChannel channel, String libraryName, String interfaceName, String messageName)
func InitializeEventMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)
Sub InitializeEventMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)
Parameters:
- channel: Communication channel that will be used to send the event message
- libraryName: RODL library name
- interfaceName: Communication channel that will be used to send the event message
- messageName: Message name. Corresponds to the name of the service method being executed
InitializeExceptionMessage (IChannel, String, String, Exception)
Should be implemented by Message components to initialize a Exception message.
method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; exception: Exception)
void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception exception)
func InitializeExceptionMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ exception: Exception)
Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, exception As Exception)
Parameters:
- channel: Communication channel that will be used to send the exception message
- interfaceName: A name of the interface (i.e. the service).
- messageName: Message name. Corresponds to the name of the service method being executed
- exception: Exception that should be serialized and sent to the client application
InitializeExceptionMessage (IChannel, String, String, String, Exception)
Should be implemented by Message components to initialize a Exception message.
method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; exception: Exception)
void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception exception)
func InitializeExceptionMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String, _ exception: Exception)
Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, exception As Exception)
Parameters:
- channel: Communication channel that will be used to send the exception message
- libraryName: RODL library name
- interfaceName: A name of the interface (i.e. the service).
- messageName: Message name. Corresponds to the name of the service method being executed
- exception: Exception that should be serialized and sent to the client application
InitializeMessage (IChannel, String, String, MessageType)
Initializes message of requested type for interface interfaceName with message name messageName on channel channel.
method InitializeMessage(channel: IChannel; interfaceName: String; messageName: String; messageType: MessageType)
void InitializeMessage(IChannel channel, String interfaceName, String messageName, MessageType messageType)
func InitializeMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ messageType: MessageType)
Sub InitializeMessage(channel As IChannel, interfaceName As String, messageName As String, messageType As MessageType)
Parameters:
- channel: Communication channel
- interfaceName: Interface name
- messageName: Message name
- messageType: Message type (event, exception etc)
InitializeMessage (IChannel, String, String, String, MessageType)
Initializes message of requested type for interface interfaceName with message name messageName on channel channel.
method InitializeMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; messageType: MessageType)
void InitializeMessage(IChannel channel, String libraryName, String interfaceName, String messageName, MessageType messageType)
func InitializeMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String, _ messageType: MessageType)
Sub InitializeMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, messageType As MessageType)
Parameters:
- channel: Communication channel
- libraryName: Library name
- interfaceName: Interface name
- messageName: Message name
- messageType: Message type (event, exception etc)
InitializeMessageEx
Initializes message of requested type on channel channel.
method InitializeMessageEx(channel: IChannel; messageType: MessageType)
void InitializeMessageEx(IChannel channel, MessageType messageType)
func InitializeMessageEx(_ channel: IChannel, _ messageType: MessageType)
Sub InitializeMessageEx(channel As IChannel, messageType As MessageType)
Parameters:
- channel: Communication channel
- messageType: Message type (event, exception etc)
InitializeRead
method InitializeRead(channel: IChannel)
void InitializeRead(IChannel channel)
func InitializeRead(_ channel: IChannel)
Sub InitializeRead(channel As IChannel)
Parameters:
- channel: Communication channnel
InitializeRequest
Sets additional options of the communication channel and data serializer.
method InitializeRequest(channel: IRequest)
void InitializeRequest(IRequest channel)
func InitializeRequest(_ channel: IRequest)
Sub InitializeRequest(channel As IRequest)
Parameters:
- channel: Communication channnel
InitializeRequestMessage (IChannel, String, String)
Should be implemented by Message components to initialize a Request message.
method InitializeRequestMessage(channel: IChannel; interfaceName: String; messageName: String)
void InitializeRequestMessage(IChannel channel, String interfaceName, String messageName)
func InitializeRequestMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)
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)
func InitializeRequestMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)
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 Message components to initialize a Response message.
method InitializeResponseMessage(channel: IChannel; interfaceName: String; messageName: String)
void InitializeResponseMessage(IChannel channel, String interfaceName, String messageName)
func InitializeResponseMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String)
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)
func InitializeResponseMessage(_ channel: IChannel, _ libraryName: String, _ interfaceName: String, _ messageName: String)
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()
func InitializeSerializer()
Sub InitializeSerializer()
ProcessException protected
method ProcessException
void ProcessException()
func ProcessException()
Sub ProcessException()
Read
Calls the appropriate method for reading the given Type (such as ReadString or ReadInt32). If the type is unsupported, an exception is raised. Objects can be written to the Serializer using the Write method. You will usually not need to override this method when implementing a custom Serializer.
method Read(name: String; type: Type; format: StreamingFormat): Object
Object Read(String name, Type type, StreamingFormat format)
func Read(_ name: String, _ type: Type, _ format: StreamingFormat) -> Object
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)
func ReadAnsiString(_ name: String) -> String
Function ReadAnsiString(name As String) As String
Parameters:
- name:
ReadBoolean
method ReadBoolean(name: String): Boolean
Boolean ReadBoolean(String name)
func ReadBoolean(_ name: String) -> Boolean
Function ReadBoolean(name As String) As Boolean
Parameters:
- name:
ReadCurrency
method ReadCurrency(name: String): Decimal
Decimal ReadCurrency(String name)
func ReadCurrency(_ name: String) -> Decimal
Function ReadCurrency(name As String) As Decimal
Parameters:
- name:
ReadDateTime
method ReadDateTime(name: String): DateTime
DateTime ReadDateTime(String name)
func ReadDateTime(_ name: String) -> DateTime
Function ReadDateTime(name As String) As DateTime
Parameters:
- name:
ReadDecimal
method ReadDecimal(name: String): Decimal
Decimal ReadDecimal(String name)
func ReadDecimal(_ name: String) -> Decimal
Function ReadDecimal(name As String) As Decimal
Parameters:
- name:
ReadDouble
method ReadDouble(name: String): Double
Double ReadDouble(String name)
func ReadDouble(_ name: String) -> Double
Function ReadDouble(name As String) As Double
Parameters:
- name:
ReadEnum
method ReadEnum(name: String; type: Type): Enum
Enum ReadEnum(String name, Type type)
func ReadEnum(_ name: String, _ type: Type) -> Enum
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()
func ReadException() -> Exception
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)
func ReadFromStream(_ stream: Stream)
Sub ReadFromStream(stream As Stream)
Parameters:
- stream:
ReadGuid
method ReadGuid(name: String): Guid
Guid ReadGuid(String name)
func ReadGuid(_ name: String) -> Guid
Function ReadGuid(name As String) As Guid
Parameters:
- name:
ReadInt32
Reads Int32
value.
method ReadInt32(name: String): Int32
Int32 ReadInt32(String name)
func ReadInt32(_ name: String) -> Int32
Function ReadInt32(name As String) As Int32
Parameters:
- name:
ReadInt64
Reads Int64
value.
method ReadInt64(name: String): Int64
Int64 ReadInt64(String name)
func ReadInt64(_ name: String) -> Int64
Function ReadInt64(name As String) As Int64
Parameters:
- name:
ReadNullableBoolean
method ReadNullableBoolean(name: String): nullable Boolean
Boolean? ReadNullableBoolean(String name)
func ReadNullableBoolean(_ name: String) -> Boolean!
Function ReadNullableBoolean(name As String) As Boolean?
Parameters:
- name:
ReadNullableCurrency
method ReadNullableCurrency(name: String): nullable Decimal
Decimal? ReadNullableCurrency(String name)
func ReadNullableCurrency(_ name: String) -> Decimal!
Function ReadNullableCurrency(name As String) As Decimal?
Parameters:
- name:
ReadNullableDateTime
method ReadNullableDateTime(name: String): nullable DateTime
DateTime? ReadNullableDateTime(String name)
func ReadNullableDateTime(_ name: String) -> DateTime!
Function ReadNullableDateTime(name As String) As DateTime?
Parameters:
- name:
ReadNullableDecimal
method ReadNullableDecimal(name: String): nullable Decimal
Decimal? ReadNullableDecimal(String name)
func ReadNullableDecimal(_ name: String) -> Decimal!
Function ReadNullableDecimal(name As String) As Decimal?
Parameters:
- name:
ReadNullableDouble
method ReadNullableDouble(name: String): nullable Double
Double? ReadNullableDouble(String name)
func ReadNullableDouble(_ name: String) -> Double!
Function ReadNullableDouble(name As String) As Double?
Parameters:
- name:
ReadNullableEnum
method ReadNullableEnum(name: String; type: Type): nullable Enum
Enum? ReadNullableEnum(String name, Type type)
func ReadNullableEnum(_ name: String, _ type: Type) -> Enum?
Function ReadNullableEnum(name As String, type As Type) As Enum?
Parameters:
- name:
- type:
ReadNullableGuid
method ReadNullableGuid(name: String): nullable Guid
Guid? ReadNullableGuid(String name)
func ReadNullableGuid(_ name: String) -> Guid!
Function ReadNullableGuid(name As String) As Guid?
Parameters:
- name:
ReadNullableInt32
method ReadNullableInt32(name: String): nullable Int32
Int32? ReadNullableInt32(String name)
func ReadNullableInt32(_ name: String) -> Int32!
Function ReadNullableInt32(name As String) As Int32?
Parameters:
- name:
ReadNullableInt64
method ReadNullableInt64(name: String): nullable Int64
Int64? ReadNullableInt64(String name)
func ReadNullableInt64(_ name: String) -> Int64!
Function ReadNullableInt64(name As String) As Int64?
Parameters:
- name:
ReadUtf8String
method ReadUtf8String(name: String): String
String ReadUtf8String(String name)
func ReadUtf8String(_ name: String) -> String
Function ReadUtf8String(name As String) As String
Parameters:
- name:
ReadVariant
method ReadVariant(name: String): Object
Object ReadVariant(String name)
func ReadVariant(_ name: String) -> Object
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)
func ReadWideString(_ name: String) -> String
Function ReadWideString(name As String) As String
Parameters:
- name:
ReadXml
method ReadXml(name: String): XmlNode
XmlNode ReadXml(String name)
func ReadXml(_ name: String) -> XmlNode
Function ReadXml(name As String) As XmlNode
Parameters:
- name:
RemapParameters protected
method RemapParameters(parameters: array of String)
void RemapParameters(String[] parameters)
func RemapParameters(_ parameters: String...)
Sub RemapParameters(parameters As String())
Parameters:
- parameters:
SetAttributes
method SetAttributes(channel: IChannel; attributeNames: array of String; attributeValues: array of String)
void SetAttributes(IChannel channel, String[] attributeNames, String[] attributeValues)
func SetAttributes(_ channel: IChannel, _ attributeNames: String..., _ attributeValues: String...)
Sub SetAttributes(channel As IChannel, attributeNames As String(), attributeValues As String())
Parameters:
- channel:
- attributeNames:
- attributeValues:
TriggerAfterReadMessageParam (String, Object) protected
method TriggerAfterReadMessageParam(name: String; parameter: Object)
void TriggerAfterReadMessageParam(String name, Object parameter)
func TriggerAfterReadMessageParam(_ name: String, _ parameter: Object)
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)
func TriggerAfterReadMessageParam(_ name: String, _ parameter: Object, _ 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)
func TriggerAfterReadMessageParam(_ name: String, _ parameter: Object, _ type: Type, _ format: StreamingFormat)
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)
func TriggerAfterUnwrapEnvelopes(_ stream: Stream)
Sub TriggerAfterUnwrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerAfterWrapEnvelopes protected
method TriggerAfterWrapEnvelopes(stream: Stream)
void TriggerAfterWrapEnvelopes(Stream stream)
func TriggerAfterWrapEnvelopes(_ stream: Stream)
Sub TriggerAfterWrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeUnwrapEnvelopes protected
method TriggerBeforeUnwrapEnvelopes(stream: Stream)
void TriggerBeforeUnwrapEnvelopes(Stream stream)
func TriggerBeforeUnwrapEnvelopes(_ stream: Stream)
Sub TriggerBeforeUnwrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeWrapEnvelopes protected
method TriggerBeforeWrapEnvelopes(stream: Stream)
void TriggerBeforeWrapEnvelopes(Stream stream)
func 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)
func TriggerBeforeWriteMessageParam(_ name: String, _ parameter: Object)
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)
func TriggerBeforeWriteMessageParam(_ name: String, _ parameter: Object, _ 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)
func TriggerBeforeWriteMessageParam(_ name: String, _ parameter: Object, _ type: Type, _ format: StreamingFormat)
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()
func 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)
func TriggerOnInitializeMessage(_ channel: IChannel, _ interfaceName: String, _ messageName: String, _ 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)
func UnwrapEnvelopes(_ stream: Stream) -> Stream
Function UnwrapEnvelopes(stream As Stream) As Stream
Parameters:
- stream:
Validate
method Validate(content: String): Boolean
Boolean Validate(String content)
func Validate(_ content: String) -> Boolean
Function Validate(content As String) As Boolean
Parameters:
- content:
WrapEnvelopes protected
method WrapEnvelopes(stream: Stream): Stream
Stream WrapEnvelopes(Stream stream)
func WrapEnvelopes(_ stream: 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)
func Write(_ name: String, _ value: Object, _ type: Type, _ format: StreamingFormat)
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)
func WriteAnsiString(_ name: String, _ value: String)
Sub WriteAnsiString(name As String, value As String)
Parameters:
- name:
- value:
WriteBoolean
method WriteBoolean(name: String; value: Boolean)
void WriteBoolean(String name, Boolean value)
func WriteBoolean(_ name: String, _ value: Boolean)
Sub WriteBoolean(name As String, value As Boolean)
Parameters:
- name:
- value:
WriteCurrency
method WriteCurrency(name: String; value: Decimal)
void WriteCurrency(String name, Decimal value)
func WriteCurrency(_ name: String, _ value: Decimal)
Sub WriteCurrency(name As String, value As Decimal)
Parameters:
- name:
- value:
WriteDateTime
method WriteDateTime(name: String; value: DateTime)
void WriteDateTime(String name, DateTime value)
func WriteDateTime(_ name: String, _ value: DateTime)
Sub WriteDateTime(name As String, value As DateTime)
Parameters:
- name:
- value:
WriteDecimal
method WriteDecimal(name: String; value: Decimal)
void WriteDecimal(String name, Decimal value)
func WriteDecimal(_ name: String, _ value: Decimal)
Sub WriteDecimal(name As String, value As Decimal)
Parameters:
- name:
- value:
WriteDouble
method WriteDouble(name: String; value: Double)
void WriteDouble(String name, Double value)
func WriteDouble(_ name: String, _ value: Double)
Sub WriteDouble(name As String, value As Double)
Parameters:
- name:
- value:
WriteEnum
method WriteEnum(name: String; value: Enum)
void WriteEnum(String name, Enum value)
func WriteEnum(_ name: String, _ value: Enum)
Sub WriteEnum(name As String, value As Enum)
Parameters:
- name:
- value:
WriteEnvelopeHeader
method WriteEnvelopeHeader(envelope: MessageEnvelope; stream: Stream)
void WriteEnvelopeHeader(MessageEnvelope envelope, Stream stream)
func WriteEnvelopeHeader(_ envelope: MessageEnvelope, _ stream: Stream)
Sub WriteEnvelopeHeader(envelope As MessageEnvelope, stream As Stream)
Parameters:
- envelope:
- stream:
WriteException
method WriteException(exception: Exception)
void WriteException(Exception exception)
func WriteException(_ exception: Exception)
Sub WriteException(exception As Exception)
Parameters:
- exception:
WriteGuid
method WriteGuid(name: String; value: Guid)
void WriteGuid(String name, Guid value)
func WriteGuid(_ name: String, _ value: Guid)
Sub WriteGuid(name As String, value As Guid)
Parameters:
- name:
- value:
WriteInt32
method WriteInt32(name: String; value: Int32)
void WriteInt32(String name, Int32 value)
func WriteInt32(_ name: String, _ value: Int32)
Sub WriteInt32(name As String, value As Int32)
Parameters:
- name:
- value:
WriteInt64
method WriteInt64(name: String; value: Int64)
void WriteInt64(String name, Int64 value)
func WriteInt64(_ name: String, _ value: Int64)
Sub WriteInt64(name As String, value As Int64)
Parameters:
- name:
- value:
WriteNullableBoolean
method WriteNullableBoolean(name: String; value: Nullable<Boolean>)
void WriteNullableBoolean(String name, Nullable<Boolean> value)
func WriteNullableBoolean(_ name: String, _ value: Nullable<Boolean>)
Sub WriteNullableBoolean(name As String, value As Nullable<Boolean>)
Parameters:
- name:
- value:
WriteNullableCurrency
method WriteNullableCurrency(name: String; value: Nullable<Decimal>)
void WriteNullableCurrency(String name, Nullable<Decimal> value)
func WriteNullableCurrency(_ name: String, _ value: Nullable<Decimal>)
Sub WriteNullableCurrency(name As String, value As Nullable<Decimal>)
Parameters:
- name:
- value:
WriteNullableDateTime
method WriteNullableDateTime(name: String; value: Nullable<DateTime>)
void WriteNullableDateTime(String name, Nullable<DateTime> value)
func WriteNullableDateTime(_ name: String, _ value: Nullable<DateTime>)
Sub WriteNullableDateTime(name As String, value As Nullable<DateTime>)
Parameters:
- name:
- value:
WriteNullableDecimal
method WriteNullableDecimal(name: String; value: Nullable<Decimal>)
void WriteNullableDecimal(String name, Nullable<Decimal> value)
func WriteNullableDecimal(_ name: String, _ value: Nullable<Decimal>)
Sub WriteNullableDecimal(name As String, value As Nullable<Decimal>)
Parameters:
- name:
- value:
WriteNullableDouble
method WriteNullableDouble(name: String; value: Nullable<Double>)
void WriteNullableDouble(String name, Nullable<Double> value)
func WriteNullableDouble(_ name: String, _ value: Nullable<Double>)
Sub WriteNullableDouble(name As String, value As Nullable<Double>)
Parameters:
- name:
- value:
WriteNullableEnum
method WriteNullableEnum(name: String; value: nullable Enum)
void WriteNullableEnum(String name, Enum? value)
func WriteNullableEnum(_ name: String, _ value: Enum?)
Sub WriteNullableEnum(name As String, value As Enum?)
Parameters:
- name:
- value:
WriteNullableGuid
method WriteNullableGuid(name: String; value: Nullable<Guid>)
void WriteNullableGuid(String name, Nullable<Guid> value)
func WriteNullableGuid(_ name: String, _ value: Nullable<Guid>)
Sub WriteNullableGuid(name As String, value As Nullable<Guid>)
Parameters:
- name:
- value:
WriteNullableInt32
method WriteNullableInt32(name: String; value: Nullable<Int32>)
void WriteNullableInt32(String name, Nullable<Int32> value)
func WriteNullableInt32(_ name: String, _ value: Nullable<Int32>)
Sub WriteNullableInt32(name As String, value As Nullable<Int32>)
Parameters:
- name:
- value:
WriteNullableInt64
method WriteNullableInt64(name: String; value: Nullable<Int64>)
void WriteNullableInt64(String name, Nullable<Int64> value)
func WriteNullableInt64(_ name: String, _ value: Nullable<Int64>)
Sub WriteNullableInt64(name As String, value As Nullable<Int64>)
Parameters:
- name:
- value:
WriteToStream
method WriteToStream(stream: Stream)
void WriteToStream(Stream stream)
func WriteToStream(_ stream: Stream)
Sub WriteToStream(stream As Stream)
Parameters:
- stream:
WriteUtf8String
method WriteUtf8String(name: String; value: String)
void WriteUtf8String(String name, String value)
func WriteUtf8String(_ name: String, _ value: String)
Sub WriteUtf8String(name As String, value As String)
Parameters:
- name:
- value:
WriteVariant
method WriteVariant(name: String; value: Object)
void WriteVariant(String name, Object value)
func WriteVariant(_ name: String, _ value: Object)
Sub WriteVariant(name As String, value As Object)
Parameters:
- name:
- value:
WriteWideString
method WriteWideString(name: String; value: String)
void WriteWideString(String name, String value)
func WriteWideString(_ name: String, _ value: String)
Sub WriteWideString(name As String, value As String)
Parameters:
- name:
- value:
WriteXml
method WriteXml(name: String; value: XmlNode)
void WriteXml(String name, XmlNode value)
func WriteXml(_ name: String, _ value: XmlNode)
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 EventHandler<MessageParamEventArgs>: AfterReadMessageParam!
Event AfterReadMessageParam As EventHandler<MessageParamEventArgs>
AfterUnwrapEnvelopes
event AfterUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> AfterUnwrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: AfterUnwrapEnvelopes!
Event AfterUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>
AfterWrapEnvelopes
event AfterWrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> AfterWrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: AfterWrapEnvelopes!
Event AfterWrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeUnwrapEnvelopes
event BeforeUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> BeforeUnwrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: BeforeUnwrapEnvelopes!
Event BeforeUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeWrapEnvelopes
event BeforeWrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> BeforeWrapEnvelopes()
__event 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 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 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 EventHandler<InitMessageEventArgs>: OnInitializeMessage!
Event OnInitializeMessage As EventHandler<InitMessageEventArgs>