ServerMultiMessage
Overview
The ServerMultiMessage class implements a Message that is able to cummunicate in different formats (f.e. binary and SOAP) via the same server URL.
For each incoming data request, the ServerMultiMessage class detects the format of the incoming data stream and then processes it. The response is sent back in the same format the request was.
To allow the ServerMultiMessage instance to properly process incoming data of various formats, the corresponding Message (f.e. BinMessage or JsonMessage) has to be registered in the AvailableMessages collection (see below).
This message type can be used only on the server side.
Note: For performance reasons it is better to use separate URL's or ports for different message types, because the ServerMultiMessage tries to determine the appropriate message format for every incoming data request.
Location
- Reference: RemObjects.SDK.Server.dll
- Namespace: RemObjects.SDK.Server
- Platforms: .NET Core, .NET Framework, .NET Standard
- Ancestry: Component | Message | ServerMultiMessage
constructor
Creates a new instance of the ServerMultiMessage class.
constructor
ServerMultiMessage()
init()
Sub New()
constructor (IContainer)
Creates a new instance of the ServerMultiMessage class and adds it to the provided components container.
constructor(container: IContainer)
ServerMultiMessage(IContainer container)
init(_ container: IContainer)
Sub New(container As IContainer)
Parameters:
- container: Components container.
AddServerExceptionPrefix (declared in Message)
// .NET Core, .NET Standard
property AddServerExceptionPrefix: Boolean read write;
// .NET Framework
[DefaultValue(true)]
property AddServerExceptionPrefix: Boolean read write;
// .NET Core, .NET Standard
Boolean AddServerExceptionPrefix { get; set; }
// .NET Framework
[DefaultValue(true)]
Boolean AddServerExceptionPrefix { get; set; }
// .NET Core, .NET Standard
var AddServerExceptionPrefix: Boolean { get{} set{} }
// .NET Framework
@DefaultValue(true)
var AddServerExceptionPrefix: Boolean { get{} set{} }
// .NET Core, .NET Standard
Property AddServerExceptionPrefix() As Boolean
// .NET Framework
<DefaultValue(true)>
Property AddServerExceptionPrefix() As Boolean
AfterReadMessageParam (declared in Message)
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 (declared in Message)
event AfterUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> AfterUnwrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: AfterUnwrapEnvelopes!
Event AfterUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>
AfterWrapEnvelopes (declared in Message)
event AfterWrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> AfterWrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: AfterWrapEnvelopes!
Event AfterWrapEnvelopes As EventHandler<StreamOperationEventArgs>
AvailableMessages
Gets or sets the collection of Message instances registered in the current ServerMultiMessage instance.
This collection is used to detect the correct message type of the incoming data stream for each data request.
property AvailableMessages: AvailableMessages read write;
AvailableMessages AvailableMessages { get; set; }
var AvailableMessages: AvailableMessages { get{} set{} }
Property AvailableMessages() As AvailableMessages
BeforeUnwrapEnvelopes (declared in Message)
event BeforeUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> BeforeUnwrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: BeforeUnwrapEnvelopes!
Event BeforeUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeWrapEnvelopes (declared in Message)
event BeforeWrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> BeforeWrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: BeforeWrapEnvelopes!
Event BeforeWrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeWriteMessageParam (declared in Message)
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 (declared in Message)
method CanRemapParameters: Boolean
Boolean CanRemapParameters()
func CanRemapParameters() -> Boolean
Function CanRemapParameters() As Boolean
CheckForEnvelope protected (declared in Message)
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 (declared in Message)
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
Returns a clone of the current instance. Items contained in the AvailableMessages collection are also cloned.
method Clone: IMessage
IMessage Clone()
func Clone() -> IMessage
Function Clone() As IMessage
CloneFrom protected (declared in Message)
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 (declared in Message)
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 (declared in Message)
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
Gets the recommended dispatcher name for the current message type.
For the BinMessage type, the ServerMultiMessage always returns auto.
property DefaultDispatcherName: String read;
String DefaultDispatcherName { get; }
var DefaultDispatcherName: String { get{} }
ReadOnly Property DefaultDispatcherName() As String
Dispose protected (declared in Message)
method Dispose(disposing: Boolean)
void Dispose(Boolean disposing)
func Dispose(_ disposing: Boolean)
Sub Dispose(disposing As Boolean)
Parameters:
- disposing:
Envelopes (declared in Message)
property Envelopes: MessageEnvelopes read;
MessageEnvelopes Envelopes { get; }
var Envelopes: MessageEnvelopes { get{} }
ReadOnly Property Envelopes() As MessageEnvelopes
FinalizeMessage
Ensures that the message content is complete before sending it by doing any final processing necessary.
The FinalizeMessage method is called after all parameters have been written to the message and before the message is to be sent.
method FinalizeMessage
void FinalizeMessage()
func FinalizeMessage()
Sub FinalizeMessage()
FinalizeRequest
Finalizes the data request serialization.
If needed, this method restores communication channel and data serializer properties.
Concrete actions performed depend on the currently active message instance.
method FinalizeRequest(channel: IRequest)
void FinalizeRequest(IRequest channel)
func FinalizeRequest(_ channel: IRequest)
Sub FinalizeRequest(channel As IRequest)
Parameters:
- channel: Communication channel
GetExceptionMessage protected (declared in Message)
method GetExceptionMessage(exception: Exception): String
String GetExceptionMessage(Exception exception)
func GetExceptionMessage(_ exception: Exception) -> String
Function GetExceptionMessage(exception As Exception) As String
Parameters:
- exception:
GetStream (declared in Message)
Creates a new stream with the content of the message.
method GetStream: Stream
Stream GetStream()
func GetStream() -> Stream
Function GetStream() As Stream
HasEnvelope (declared in Message)
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) (declared in Message)
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
- libraryName: Library name
- interfaceName: Interface name
- messageName: Message name
InitializeExceptionMessage (IChannel, String, String, Exception) (declared in Message)
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)
Initializes a new exception message for interface interfaceName with message name messageName on channel channel.
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
- libraryName: Library name
- interfaceName: Interface name
- messageName: Message name
- exception: Exception that should be stored in the message
InitializeMessage (IChannel, String, String, MessageType) (declared in Message)
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 (declared in Message)
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.
Concrete actions performed depend on the currently active message instance.
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) (declared in Message)
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) (declared in Message)
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) (declared in Message)
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) (declared in Message)
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 (declared in Message)
Contains the name of the interface (i.e. the service) that is being called (read-only).
// .NET Core, .NET Standard
property InterfaceName: String read write;
// .NET Framework
[DefaultValue(nil)]
property InterfaceName: String read write;
// .NET Core, .NET Standard
String InterfaceName { get; set; }
// .NET Framework
[DefaultValue(null)]
String InterfaceName { get; set; }
// .NET Core, .NET Standard
var InterfaceName: String { get{} set{} }
// .NET Framework
@DefaultValue(nil)
var InterfaceName: String { get{} set{} }
// .NET Core, .NET Standard
Property InterfaceName() As String
// .NET Framework
<DefaultValue(Nothing)>
Property InterfaceName() As String
IsValidMessage (declared in Message)
property IsValidMessage: Boolean read;
Boolean IsValidMessage { get; }
var IsValidMessage: Boolean { get{} }
ReadOnly Property IsValidMessage() As Boolean
MaxStringSize (declared in Message)
// .NET Core, .NET Standard
property MaxStringSize: Int32 read write;
// .NET Framework
[DefaultValue(-1)]
property MaxStringSize: Int32 read write;
// .NET Core, .NET Standard
Int32 MaxStringSize { get; set; }
// .NET Framework
[DefaultValue(-1)]
Int32 MaxStringSize { get; set; }
// .NET Core, .NET Standard
var MaxStringSize: Int32 { get{} set{} }
// .NET Framework
@DefaultValue(-1)
var MaxStringSize: Int32 { get{} set{} }
// .NET Core, .NET Standard
Property MaxStringSize() As Int32
// .NET Framework
<DefaultValue(-1)>
Property MaxStringSize() As Int32
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
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 (declared in Message)
Contains the name of the message (i.e. the method) that is being called (read-only).
// .NET Core, .NET Standard
property MessageName: String read write;
// .NET Framework
[DefaultValue(nil)]
property MessageName: String read write;
// .NET Core, .NET Standard
String MessageName { get; set; }
// .NET Framework
[DefaultValue(null)]
String MessageName { get; set; }
// .NET Core, .NET Standard
var MessageName: String { get{} set{} }
// .NET Framework
@DefaultValue(nil)
var MessageName: String { get{} set{} }
// .NET Core, .NET Standard
Property MessageName() As String
// .NET Framework
<DefaultValue(Nothing)>
Property MessageName() As String
MessageType (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method ProcessException
void ProcessException()
func ProcessException()
Sub ProcessException()
Read (declared in Message)
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 (declared in Message)
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 (declared in Message)
method ReadBoolean(name: String): Boolean
Boolean ReadBoolean(String name)
func ReadBoolean(_ name: String) -> Boolean
Function ReadBoolean(name As String) As Boolean
Parameters:
- name:
ReadCurrency (declared in Message)
method ReadCurrency(name: String): Decimal
Decimal ReadCurrency(String name)
func ReadCurrency(_ name: String) -> Decimal
Function ReadCurrency(name As String) As Decimal
Parameters:
- name:
ReadDateTime (declared in Message)
method ReadDateTime(name: String): DateTime
DateTime ReadDateTime(String name)
func ReadDateTime(_ name: String) -> DateTime
Function ReadDateTime(name As String) As DateTime
Parameters:
- name:
ReadDecimal (declared in Message)
method ReadDecimal(name: String): Decimal
Decimal ReadDecimal(String name)
func ReadDecimal(_ name: String) -> Decimal
Function ReadDecimal(name As String) As Decimal
Parameters:
- name:
ReadDouble (declared in Message)
method ReadDouble(name: String): Double
Double ReadDouble(String name)
func ReadDouble(_ name: String) -> Double
Function ReadDouble(name As String) As Double
Parameters:
- name:
ReadEnum (declared in Message)
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
Deserializes information about the occurred exception and raises the appropriate exception.
This method uses the SerializerInstance to ensure that data is processed using the proper deserializer.
method ReadException: Exception
Exception ReadException()
func ReadException() -> Exception
Function ReadException() As Exception
ReadFromStream (declared in Message)
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 (declared in Message)
method ReadGuid(name: String): Guid
Guid ReadGuid(String name)
func ReadGuid(_ name: String) -> Guid
Function ReadGuid(name As String) As Guid
Parameters:
- name:
ReadInt32 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method ReadUtf8String(name: String): String
String ReadUtf8String(String name)
func ReadUtf8String(_ name: String) -> String
Function ReadUtf8String(name As String) As String
Parameters:
- name:
ReadVariant (declared in Message)
method ReadVariant(name: String): Object
Object ReadVariant(String name)
func ReadVariant(_ name: String) -> Object
Function ReadVariant(name As String) As Object
Parameters:
- name:
ReadWideString (declared in Message)
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 (declared in Message)
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 (declared in Message)
method RemapParameters(parameters: array of String)
void RemapParameters(String[] parameters)
func RemapParameters(_ parameters: String...)
Sub RemapParameters(parameters As String())
Parameters:
- parameters:
SerializerInstance (declared in Message)
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 (declared in Message)
// .NET Core, .NET Standard
property ServerExceptionPrefix: String read write;
// .NET Framework
[DefaultValue('An exception occurred on the server: ')]
property ServerExceptionPrefix: String read write;
// .NET Core, .NET Standard
String ServerExceptionPrefix { get; set; }
// .NET Framework
[DefaultValue(\"An exception occurred on the server: \")]
String ServerExceptionPrefix { get; set; }
// .NET Core, .NET Standard
var ServerExceptionPrefix: String { get{} set{} }
// .NET Framework
@DefaultValue(\"An exception occurred on the server: \")
var ServerExceptionPrefix: String { get{} set{} }
// .NET Core, .NET Standard
Property ServerExceptionPrefix() As String
// .NET Framework
<DefaultValue(\"An exception occurred on the server: \")>
Property ServerExceptionPrefix() As String
SetAttributes
Sets the internal serializer options based on the provided attributes names and values.
Also depending on the cussrently active messase can check the HTTP headers of the incoming HTTP request and set the corresponding serializer options (f.e. for SOAP messages).
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: Communication channel
- attributeNames: Collection of attribute names
- attributeValues: Collection of attribute names in the same order as they are mentioned in the attributeNames parameter
TriggerAfterReadMessageParam (String, Object) protected (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method TriggerAfterUnwrapEnvelopes(stream: Stream)
void TriggerAfterUnwrapEnvelopes(Stream stream)
func TriggerAfterUnwrapEnvelopes(_ stream: Stream)
Sub TriggerAfterUnwrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerAfterWrapEnvelopes protected (declared in Message)
method TriggerAfterWrapEnvelopes(stream: Stream)
void TriggerAfterWrapEnvelopes(Stream stream)
func TriggerAfterWrapEnvelopes(_ stream: Stream)
Sub TriggerAfterWrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeUnwrapEnvelopes protected (declared in Message)
method TriggerBeforeUnwrapEnvelopes(stream: Stream)
void TriggerBeforeUnwrapEnvelopes(Stream stream)
func TriggerBeforeUnwrapEnvelopes(_ stream: Stream)
Sub TriggerBeforeUnwrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeWrapEnvelopes protected (declared in Message)
method TriggerBeforeWrapEnvelopes(stream: Stream)
void TriggerBeforeWrapEnvelopes(Stream stream)
func TriggerBeforeWrapEnvelopes(_ stream: Stream)
Sub TriggerBeforeWrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeWriteMessageParam (String, Object) protected (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method TriggerOnFinalizeMessage
void TriggerOnFinalizeMessage()
func TriggerOnFinalizeMessage()
Sub TriggerOnFinalizeMessage()
TriggerOnInitializeMessage protected (declared in Message)
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 (declared in Message)
method UnwrapEnvelopes(stream: Stream): Stream
Stream UnwrapEnvelopes(Stream stream)
func UnwrapEnvelopes(_ stream: Stream) -> Stream
Function UnwrapEnvelopes(stream As Stream) As Stream
Parameters:
- stream:
Validate (declared in Message)
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 (declared in Message)
method WrapEnvelopes(stream: Stream): Stream
Stream WrapEnvelopes(Stream stream)
func WrapEnvelopes(_ stream: Stream) -> Stream
Function WrapEnvelopes(stream As Stream) As Stream
Parameters:
- stream:
Write (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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
Writes information about the occurred exception.
method WriteException(exception: Exception)
void WriteException(Exception exception)
func WriteException(_ exception: Exception)
Sub WriteException(exception As Exception)
Parameters:
- exception: Exception instance
WriteGuid (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method WriteToStream(stream: Stream)
void WriteToStream(Stream stream)
func WriteToStream(_ stream: Stream)
Sub WriteToStream(stream As Stream)
Parameters:
- stream:
WriteUtf8String (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
// .NET Core, .NET Standard
property AddServerExceptionPrefix: Boolean read write;
// .NET Framework
[DefaultValue(true)]
property AddServerExceptionPrefix: Boolean read write;
// .NET Core, .NET Standard
Boolean AddServerExceptionPrefix { get; set; }
// .NET Framework
[DefaultValue(true)]
Boolean AddServerExceptionPrefix { get; set; }
// .NET Core, .NET Standard
var AddServerExceptionPrefix: Boolean { get{} set{} }
// .NET Framework
@DefaultValue(true)
var AddServerExceptionPrefix: Boolean { get{} set{} }
// .NET Core, .NET Standard
Property AddServerExceptionPrefix() As Boolean
// .NET Framework
<DefaultValue(true)>
Property AddServerExceptionPrefix() As Boolean
AvailableMessages
Gets or sets the collection of Message instances registered in the current ServerMultiMessage instance.
This collection is used to detect the correct message type of the incoming data stream for each data request.
property AvailableMessages: AvailableMessages read write;
AvailableMessages AvailableMessages { get; set; }
var AvailableMessages: AvailableMessages { get{} set{} }
Property AvailableMessages() As AvailableMessages
ClientID (declared in Message)
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 (declared in Message)
Gets message's content type.
property ContentType: String read write;
String ContentType { get; set; }
var ContentType: String { get{} set{} }
Property ContentType() As String
DefaultDispatcherName
Gets the recommended dispatcher name for the current message type.
For the BinMessage type, the ServerMultiMessage always returns auto.
property DefaultDispatcherName: String read;
String DefaultDispatcherName { get; }
var DefaultDispatcherName: String { get{} }
ReadOnly Property DefaultDispatcherName() As String
Envelopes (declared in Message)
property Envelopes: MessageEnvelopes read;
MessageEnvelopes Envelopes { get; }
var Envelopes: MessageEnvelopes { get{} }
ReadOnly Property Envelopes() As MessageEnvelopes
InterfaceName (declared in Message)
Contains the name of the interface (i.e. the service) that is being called (read-only).
// .NET Core, .NET Standard
property InterfaceName: String read write;
// .NET Framework
[DefaultValue(nil)]
property InterfaceName: String read write;
// .NET Core, .NET Standard
String InterfaceName { get; set; }
// .NET Framework
[DefaultValue(null)]
String InterfaceName { get; set; }
// .NET Core, .NET Standard
var InterfaceName: String { get{} set{} }
// .NET Framework
@DefaultValue(nil)
var InterfaceName: String { get{} set{} }
// .NET Core, .NET Standard
Property InterfaceName() As String
// .NET Framework
<DefaultValue(Nothing)>
Property InterfaceName() As String
IsValidMessage (declared in Message)
property IsValidMessage: Boolean read;
Boolean IsValidMessage { get; }
var IsValidMessage: Boolean { get{} }
ReadOnly Property IsValidMessage() As Boolean
MaxStringSize (declared in Message)
// .NET Core, .NET Standard
property MaxStringSize: Int32 read write;
// .NET Framework
[DefaultValue(-1)]
property MaxStringSize: Int32 read write;
// .NET Core, .NET Standard
Int32 MaxStringSize { get; set; }
// .NET Framework
[DefaultValue(-1)]
Int32 MaxStringSize { get; set; }
// .NET Core, .NET Standard
var MaxStringSize: Int32 { get{} set{} }
// .NET Framework
@DefaultValue(-1)
var MaxStringSize: Int32 { get{} set{} }
// .NET Core, .NET Standard
Property MaxStringSize() As Int32
// .NET Framework
<DefaultValue(-1)>
Property MaxStringSize() As Int32
MessageName (declared in Message)
Contains the name of the message (i.e. the method) that is being called (read-only).
// .NET Core, .NET Standard
property MessageName: String read write;
// .NET Framework
[DefaultValue(nil)]
property MessageName: String read write;
// .NET Core, .NET Standard
String MessageName { get; set; }
// .NET Framework
[DefaultValue(null)]
String MessageName { get; set; }
// .NET Core, .NET Standard
var MessageName: String { get{} set{} }
// .NET Framework
@DefaultValue(nil)
var MessageName: String { get{} set{} }
// .NET Core, .NET Standard
Property MessageName() As String
// .NET Framework
<DefaultValue(Nothing)>
Property MessageName() As String
MessageType (declared in Message)
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 (declared in Message)
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 (declared in Message)
// .NET Core, .NET Standard
property ServerExceptionPrefix: String read write;
// .NET Framework
[DefaultValue('An exception occurred on the server: ')]
property ServerExceptionPrefix: String read write;
// .NET Core, .NET Standard
String ServerExceptionPrefix { get; set; }
// .NET Framework
[DefaultValue(\"An exception occurred on the server: \")]
String ServerExceptionPrefix { get; set; }
// .NET Core, .NET Standard
var ServerExceptionPrefix: String { get{} set{} }
// .NET Framework
@DefaultValue(\"An exception occurred on the server: \")
var ServerExceptionPrefix: String { get{} set{} }
// .NET Core, .NET Standard
Property ServerExceptionPrefix() As String
// .NET Framework
<DefaultValue(\"An exception occurred on the server: \")>
Property ServerExceptionPrefix() As String
HasEnvelope (declared in Message)
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:
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
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
Creates a new instance of the ServerMultiMessage class.
constructor
ServerMultiMessage()
init()
Sub New()
constructor (IContainer)
Creates a new instance of the ServerMultiMessage class and adds it to the provided components container.
constructor(container: IContainer)
ServerMultiMessage(IContainer container)
init(_ container: IContainer)
Sub New(container As IContainer)
Parameters:
- container: Components container.
CanRemapParameters protected (declared in Message)
method CanRemapParameters: Boolean
Boolean CanRemapParameters()
func CanRemapParameters() -> Boolean
Function CanRemapParameters() As Boolean
CheckForEnvelope protected (declared in Message)
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
Returns a clone of the current instance. Items contained in the AvailableMessages collection are also cloned.
method Clone: IMessage
IMessage Clone()
func Clone() -> IMessage
Function Clone() As IMessage
CloneFrom protected (declared in Message)
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 (declared in Message)
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 (declared in Message)
method Dispose(disposing: Boolean)
void Dispose(Boolean disposing)
func Dispose(_ disposing: Boolean)
Sub Dispose(disposing As Boolean)
Parameters:
- disposing:
FinalizeMessage
Ensures that the message content is complete before sending it by doing any final processing necessary.
The FinalizeMessage method is called after all parameters have been written to the message and before the message is to be sent.
method FinalizeMessage
void FinalizeMessage()
func FinalizeMessage()
Sub FinalizeMessage()
FinalizeRequest
Finalizes the data request serialization.
If needed, this method restores communication channel and data serializer properties.
Concrete actions performed depend on the currently active message instance.
method FinalizeRequest(channel: IRequest)
void FinalizeRequest(IRequest channel)
func FinalizeRequest(_ channel: IRequest)
Sub FinalizeRequest(channel As IRequest)
Parameters:
- channel: Communication channel
GetExceptionMessage protected (declared in Message)
method GetExceptionMessage(exception: Exception): String
String GetExceptionMessage(Exception exception)
func GetExceptionMessage(_ exception: Exception) -> String
Function GetExceptionMessage(exception As Exception) As String
Parameters:
- exception:
GetStream (declared in Message)
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) (declared in Message)
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
- libraryName: Library name
- interfaceName: Interface name
- messageName: Message name
InitializeExceptionMessage (IChannel, String, String, Exception) (declared in Message)
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)
Initializes a new exception message for interface interfaceName with message name messageName on channel channel.
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
- libraryName: Library name
- interfaceName: Interface name
- messageName: Message name
- exception: Exception that should be stored in the message
InitializeMessage (IChannel, String, String, MessageType) (declared in Message)
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 (declared in Message)
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.
Concrete actions performed depend on the currently active message instance.
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) (declared in Message)
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) (declared in Message)
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) (declared in Message)
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) (declared in Message)
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 (declared in Message)
method ProcessException
void ProcessException()
func ProcessException()
Sub ProcessException()
Read (declared in Message)
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 (declared in Message)
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 (declared in Message)
method ReadBoolean(name: String): Boolean
Boolean ReadBoolean(String name)
func ReadBoolean(_ name: String) -> Boolean
Function ReadBoolean(name As String) As Boolean
Parameters:
- name:
ReadCurrency (declared in Message)
method ReadCurrency(name: String): Decimal
Decimal ReadCurrency(String name)
func ReadCurrency(_ name: String) -> Decimal
Function ReadCurrency(name As String) As Decimal
Parameters:
- name:
ReadDateTime (declared in Message)
method ReadDateTime(name: String): DateTime
DateTime ReadDateTime(String name)
func ReadDateTime(_ name: String) -> DateTime
Function ReadDateTime(name As String) As DateTime
Parameters:
- name:
ReadDecimal (declared in Message)
method ReadDecimal(name: String): Decimal
Decimal ReadDecimal(String name)
func ReadDecimal(_ name: String) -> Decimal
Function ReadDecimal(name As String) As Decimal
Parameters:
- name:
ReadDouble (declared in Message)
method ReadDouble(name: String): Double
Double ReadDouble(String name)
func ReadDouble(_ name: String) -> Double
Function ReadDouble(name As String) As Double
Parameters:
- name:
ReadEnum (declared in Message)
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
Deserializes information about the occurred exception and raises the appropriate exception.
This method uses the SerializerInstance to ensure that data is processed using the proper deserializer.
method ReadException: Exception
Exception ReadException()
func ReadException() -> Exception
Function ReadException() As Exception
ReadFromStream (declared in Message)
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 (declared in Message)
method ReadGuid(name: String): Guid
Guid ReadGuid(String name)
func ReadGuid(_ name: String) -> Guid
Function ReadGuid(name As String) As Guid
Parameters:
- name:
ReadInt32 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method ReadUtf8String(name: String): String
String ReadUtf8String(String name)
func ReadUtf8String(_ name: String) -> String
Function ReadUtf8String(name As String) As String
Parameters:
- name:
ReadVariant (declared in Message)
method ReadVariant(name: String): Object
Object ReadVariant(String name)
func ReadVariant(_ name: String) -> Object
Function ReadVariant(name As String) As Object
Parameters:
- name:
ReadWideString (declared in Message)
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 (declared in Message)
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 (declared in Message)
method RemapParameters(parameters: array of String)
void RemapParameters(String[] parameters)
func RemapParameters(_ parameters: String...)
Sub RemapParameters(parameters As String())
Parameters:
- parameters:
SetAttributes
Sets the internal serializer options based on the provided attributes names and values.
Also depending on the cussrently active messase can check the HTTP headers of the incoming HTTP request and set the corresponding serializer options (f.e. for SOAP messages).
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: Communication channel
- attributeNames: Collection of attribute names
- attributeValues: Collection of attribute names in the same order as they are mentioned in the attributeNames parameter
TriggerAfterReadMessageParam (String, Object) protected (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method TriggerAfterUnwrapEnvelopes(stream: Stream)
void TriggerAfterUnwrapEnvelopes(Stream stream)
func TriggerAfterUnwrapEnvelopes(_ stream: Stream)
Sub TriggerAfterUnwrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerAfterWrapEnvelopes protected (declared in Message)
method TriggerAfterWrapEnvelopes(stream: Stream)
void TriggerAfterWrapEnvelopes(Stream stream)
func TriggerAfterWrapEnvelopes(_ stream: Stream)
Sub TriggerAfterWrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeUnwrapEnvelopes protected (declared in Message)
method TriggerBeforeUnwrapEnvelopes(stream: Stream)
void TriggerBeforeUnwrapEnvelopes(Stream stream)
func TriggerBeforeUnwrapEnvelopes(_ stream: Stream)
Sub TriggerBeforeUnwrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeWrapEnvelopes protected (declared in Message)
method TriggerBeforeWrapEnvelopes(stream: Stream)
void TriggerBeforeWrapEnvelopes(Stream stream)
func TriggerBeforeWrapEnvelopes(_ stream: Stream)
Sub TriggerBeforeWrapEnvelopes(stream As Stream)
Parameters:
- stream:
TriggerBeforeWriteMessageParam (String, Object) protected (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method TriggerOnFinalizeMessage
void TriggerOnFinalizeMessage()
func TriggerOnFinalizeMessage()
Sub TriggerOnFinalizeMessage()
TriggerOnInitializeMessage protected (declared in Message)
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 (declared in Message)
method UnwrapEnvelopes(stream: Stream): Stream
Stream UnwrapEnvelopes(Stream stream)
func UnwrapEnvelopes(_ stream: Stream) -> Stream
Function UnwrapEnvelopes(stream As Stream) As Stream
Parameters:
- stream:
Validate (declared in Message)
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 (declared in Message)
method WrapEnvelopes(stream: Stream): Stream
Stream WrapEnvelopes(Stream stream)
func WrapEnvelopes(_ stream: Stream) -> Stream
Function WrapEnvelopes(stream As Stream) As Stream
Parameters:
- stream:
Write (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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
Writes information about the occurred exception.
method WriteException(exception: Exception)
void WriteException(Exception exception)
func WriteException(_ exception: Exception)
Sub WriteException(exception As Exception)
Parameters:
- exception: Exception instance
WriteGuid (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
method WriteToStream(stream: Stream)
void WriteToStream(Stream stream)
func WriteToStream(_ stream: Stream)
Sub WriteToStream(stream As Stream)
Parameters:
- stream:
WriteUtf8String (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
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 (declared in Message)
event AfterUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> AfterUnwrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: AfterUnwrapEnvelopes!
Event AfterUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>
AfterWrapEnvelopes (declared in Message)
event AfterWrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> AfterWrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: AfterWrapEnvelopes!
Event AfterWrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeUnwrapEnvelopes (declared in Message)
event BeforeUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> BeforeUnwrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: BeforeUnwrapEnvelopes!
Event BeforeUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeWrapEnvelopes (declared in Message)
event BeforeWrapEnvelopes: EventHandler<StreamOperationEventArgs>
delegate EventHandler<StreamOperationEventArgs> BeforeWrapEnvelopes()
__event EventHandler<StreamOperationEventArgs>: BeforeWrapEnvelopes!
Event BeforeWrapEnvelopes As EventHandler<StreamOperationEventArgs>
BeforeWriteMessageParam (declared in Message)
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 (declared in Message)
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 (declared in Message)
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>