BinMessage Class (.NET)

From RemObjects Wiki
Jump to: navigation, search

This is a Library topic for RemObjects SDK for .NET
This page is generated from external data, please do not update

Namespaces — Interfaces — Classes — Enums — Implements

Contents

Overview

The BinMessage component implements a Message type that can be used to encode messages in a proprietary binary format to send between client and server. Though the format used is proprietary, it is highly efficient and small. For a slower, but an open-standard protocol, use SOAP Message.

The BinMessage format is compatible with the BinMessage component used by the RemObjects SDK for Delphi.


Location

  • Assembly: RemObjects.SDK.dll
  • Namespace: RemObjects.SDK
  • Ancestry: System.ComponentModel.Component | Message | BinMessage


Properties

AddServerExceptionPrefix     (declared in Message)



Prism:   property AddServerExceptionPrefix: Boolean read write
C#:   Boolean AddServerExceptionPrefix { get; set; }
VB:   Property AddServerExceptionPrefix As Boolean


ClientID     (declared in Message)

Contains the Client ID for the message. Client IDs are used by the RemObjects 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.



Prism:   property ClientID: Guid read write
C#:   Guid ClientID { get; set; }
VB:   Property ClientID As Guid


ContentType

Overriden readonly property, which specifies message's content type. For BinMessage this is "application/octet-stream".



Prism:   property ContentType: String read
C#:   String ContentType { get; }
VB:   Property ReadOnly ContentType As String


DefaultDispatcherName

This property will return the default/recommended dispatcher name for the message type. For BinMessage, this will always be the string constant "bin".



Prism:   property DefaultDispatcherName: String read
C#:   String DefaultDispatcherName { get; }
VB:   Property ReadOnly DefaultDispatcherName As String


EnforceMaxMessageSize

Toggles whether the MaxMessageSize and MaxDecompressedMessageSize values will be enforced for incoming messages (true) or not (false). The recommendation is to have this enabled for servers and for clients that will talk to potentially non-trusted server applications.



Prism:   property EnforceMaxMessageSize: Boolean read write
C#:   Boolean EnforceMaxMessageSize { get; set; }
VB:   Property EnforceMaxMessageSize As Boolean


Envelopes     (declared in Message)



Prism:   property Envelopes: MessageEnvelopes read
C#:   MessageEnvelopes Envelopes { get; }
VB:   Property ReadOnly Envelopes As MessageEnvelopes


InterfaceName     (declared in Message)

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



Prism:   property InterfaceName: String read write
C#:   String InterfaceName { get; set; }
VB:   Property InterfaceName As String


IsValidMessage     (declared in Message)



Prism:   property IsValidMessage: Boolean read
C#:   Boolean IsValidMessage { get; }
VB:   Property ReadOnly IsValidMessage As Boolean


MaxDecompressedMessageSize

Controls the maximum message size to be received. The message class will reject messages that, when extracted, are larger then the configured value. This is to avoid malicious users overloading the server by sending spoofed ZLib packets that are small but expand to large blocks.



Prism:   property MaxDecompressedMessageSize: Int32 read write
C#:   Int32 MaxDecompressedMessageSize { get; set; }
VB:   Property MaxDecompressedMessageSize As Int32


MaxMessageSize

Controls the maximum message size to be received. This serves as a security measure to prevent denial-of-service attacks, as it prevents attackers from bringing down your application by sending huge messages.



Prism:   property MaxMessageSize: Int32 read write
C#:   Int32 MaxMessageSize { get; set; }
VB:   Property MaxMessageSize As Int32


MessageName     (declared in Message)

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



Prism:   property MessageName: String read write
C#:   String MessageName { get; set; }
VB:   Property MessageName As String


MessageType     (declared in Message)

Contains the Type of message represented by the message instance.



Prism:   property MessageType: MessageType read write
C#:   MessageType MessageType { get; set; }
VB:   Property MessageType As MessageType


MessageVersion

Contains the version number of the last message received. The currently supported message version is 107; future builds of the RemObjects SDK might contain extended support for newer message versions, if changes to the message format are introduced.



Prism:   property MessageVersion: Int32 read
C#:   Int32 MessageVersion { get; }
VB:   Property ReadOnly MessageVersion As Int32


MinSizeForCompression

Minimum size for a message before compression is applied (default is 4096 bytes). Messages below this threshold are sent uncompressed, as the overhead of compressing and decompressing the data would likely outweigh the gain of having only slightly smaller packet on the network.



Prism:   property MinSizeForCompression: Int32 read write
C#:   Int32 MinSizeForCompression { get; set; }
VB:   Property MinSizeForCompression As Int32


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.



Prism:   property SerializerInstance: Serializer read write
C#:   Serializer SerializerInstance { get; set; }
VB:   Property SerializerInstance As Serializer


ServerExceptionPrefix     (declared in Message)



Prism:   property ServerExceptionPrefix: String read write
C#:   String ServerExceptionPrefix { get; set; }
VB:   Property ServerExceptionPrefix As String


UseCompression

Determines whether Compression will be used for outgoing messages. The message will be able to handle compressed and uncompressed incoming messages, regardless of this setting. Check the BinHeader's Compressed property to determine if compression was used on an incoming message.



Prism:   property UseCompression: Boolean read write
C#:   Boolean UseCompression { get; set; }
VB:   Property UseCompression As Boolean


Class Methods

HasEnvelope     (declared in Message)



Oxygene:   class method HasEnvelope(data: array of Byte): Boolean
C#:   static Boolean HasEnvelope(array of Byte data)
VB:   Shared Function HasEnvelope(data As array of Byte) As Boolean


Parameters:

  • data:


MessageMatchingTargetUri     (declared in Message)



Oxygene:   class method MessageMatchingTargetUri(uri: Uri): IMessage
C#:   static IMessage MessageMatchingTargetUri(Uri uri)
VB:   Shared Function MessageMatchingTargetUri(uri As Uri) As IMessage


Parameters:

  • uri:


MessageMatchingTargetUrl     (declared in Message)



Oxygene:   class method MessageMatchingTargetUrl(url: String): IMessage
C#:   static IMessage MessageMatchingTargetUrl(String url)
VB:   Shared Function MessageMatchingTargetUrl(url As String) As IMessage


Parameters:

  • url:


Instance Methods

constructor

Default constructor


Oxygene:   constructor
C#:   constructor()
VB:   Sub New


CheckForEnvelope   protected     (declared in Message)



Oxygene:   method CheckForEnvelope(stream: Stream; out envelopeName: String): Boolean
C#:   Boolean CheckForEnvelope(Stream stream, out String envelopeName)
VB:   Function CheckForEnvelope(stream As Stream, <OutAttribute> ByRef envelopeName As String) As Boolean


Parameters:

  • stream:
  • envelopeName:


Clear

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


Oxygene:   method Clear
C#:   void Clear()
VB:   Sub Clear


ClearAttributes     (declared in Message)



Oxygene:   method ClearAttributes(channel: IChannel)
C#:   void ClearAttributes(IChannel channel)
VB:   Sub ClearAttributes(channel As IChannel)


Parameters:

  • channel:


Clone

Creates and returns an identical copy of the message aMessage.


Oxygene:   method Clone: IMessage
C#:   IMessage Clone()
VB:   Function Clone As IMessage


CloneFrom   protected

Creates identical copy of the message aMessage and assignes it to the current BinMessage instance.


Oxygene:   method CloneFrom(message: Message)
C#:   void CloneFrom(Message message)
VB:   Sub CloneFrom(message As Message)


Parameters:

  • message:


CreateException   protected     (declared in Message)



Oxygene:   method CreateException(exceptionName: String; message: String): Exception
C#:   Exception CreateException(String exceptionName, String message)
VB:   Function CreateException(exceptionName As String, message As String) As Exception


Parameters:

  • exceptionName:
  • message:


DoReadFromStream   protected

Reads message from stream iStream and assignes it to the current BinMessage instance


Oxygene:   method DoReadFromStream(stream: Stream)
C#:   void DoReadFromStream(Stream stream)
VB:   Sub DoReadFromStream(stream As Stream)


Parameters:

  • stream:


DoWriteToStream   protected

Writes current message to stream iStream


Oxygene:   method DoWriteToStream(stream: Stream)
C#:   void DoWriteToStream(Stream stream)
VB:   Sub DoWriteToStream(stream As Stream)


Parameters:

  • stream:


FinalizeMessage     (declared in Message)

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.


Oxygene:   method FinalizeMessage
C#:   void FinalizeMessage()
VB:   Sub FinalizeMessage


FinalizeRequest     (declared in Message)



Oxygene:   method FinalizeRequest(channel: IRequest)
C#:   void FinalizeRequest(IRequest channel)
VB:   Sub FinalizeRequest(channel As IRequest)


Parameters:

  • channel:


GetStream     (declared in Message)

Creates a new stream with the content of the message.


Oxygene:   method GetStream: Stream
C#:   Stream GetStream()
VB:   Function GetStream As Stream


InitializeEventMessage (IChannel, String, String)

Initializes new event message for interface aInterfaceName with message name aMessageName on channel aChannel.


Oxygene:   method InitializeEventMessage(channel: IChannel; interfaceName: String; messageName: String)
C#:   void InitializeEventMessage(IChannel channel, String interfaceName, String messageName)
VB:   Sub InitializeEventMessage(channel As IChannel, interfaceName As String, messageName As String)


Parameters:

  • channel:
  • interfaceName:
  • messageName:


InitializeEventMessage (IChannel, String, String, String)     (declared in Message)



Oxygene:   method InitializeEventMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)
C#:   void InitializeEventMessage(IChannel channel, String libraryName, String interfaceName, String messageName)
VB:   Sub InitializeEventMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)


Parameters:

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


InitializeExceptionMessage (IChannel, String, String, Exception)

Initializes new exception message for interface aInterfaceName with message name aMessageName on channel aChannel.


Oxygene:   method InitializeExceptionMessage(channel: IChannel; interfaceName: String; messageName: String; exception: Exception)
C#:   void InitializeExceptionMessage(IChannel channel, String interfaceName, String messageName, Exception exception)
VB:   Sub InitializeExceptionMessage(channel As IChannel, interfaceName As String, messageName As String, exception As Exception)


Parameters:

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


InitializeExceptionMessage (IChannel, String, String, String, Exception)     (declared in Message)



Oxygene:   method InitializeExceptionMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; exception: Exception)
C#:   void InitializeExceptionMessage(IChannel channel, String libraryName, String interfaceName, String messageName, Exception exception)
VB:   Sub InitializeExceptionMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, exception As Exception)


Parameters:

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


InitializeMessage (IChannel, String, String, MessageType)

Initializes custom message of type MessageType for interface aInterfaceName with message name aMessageName on channel aChannel.


Oxygene:   method InitializeMessage(channel: IChannel; interfaceName: String; messageName: String; messageType: MessageType)
C#:   void InitializeMessage(IChannel channel, String interfaceName, String messageName, MessageType messageType)
VB:   Sub InitializeMessage(channel As IChannel, interfaceName As String, messageName As String, messageType As MessageType)


Parameters:

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


InitializeMessage (IChannel, String, String, String, MessageType)     (declared in Message)



Oxygene:   method InitializeMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String; messageType: MessageType)
C#:   void InitializeMessage(IChannel channel, String libraryName, String interfaceName, String messageName, MessageType messageType)
VB:   Sub InitializeMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String, messageType As MessageType)


Parameters:

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


InitializeMessageEx

Initializes empty custom message.


Oxygene:   method InitializeMessageEx(channel: IChannel; messageType: MessageType)
C#:   void InitializeMessageEx(IChannel channel, MessageType messageType)
VB:   Sub InitializeMessageEx(channel As IChannel, messageType As MessageType)


Parameters:

  • channel:
  • messageType:


InitializeRead     (declared in Message)



Oxygene:   method InitializeRead(channel: IChannel)
C#:   void InitializeRead(IChannel channel)
VB:   Sub InitializeRead(channel As IChannel)


Parameters:

  • channel:


InitializeRequest     (declared in Message)



Oxygene:   method InitializeRequest(channel: IRequest)
C#:   void InitializeRequest(IRequest channel)
VB:   Sub InitializeRequest(channel As IRequest)


Parameters:

  • channel:


InitializeRequestMessage (IChannel, String, String)     (declared in Message)

Should be implemented by Message components to initialize a Request message.


Oxygene:   method InitializeRequestMessage(channel: IChannel; interfaceName: String; messageName: String)
C#:   void InitializeRequestMessage(IChannel channel, String interfaceName, String messageName)
VB:   Sub InitializeRequestMessage(channel As IChannel, interfaceName As String, messageName As String)


Parameters:

  • channel:
  • interfaceName:
  • messageName:


InitializeRequestMessage (IChannel, String, String, String)     (declared in Message)



Oxygene:   method InitializeRequestMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)
C#:   void InitializeRequestMessage(IChannel channel, String libraryName, String interfaceName, String messageName)
VB:   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.


Oxygene:   method InitializeResponseMessage(channel: IChannel; interfaceName: String; messageName: String)
C#:   void InitializeResponseMessage(IChannel channel, String interfaceName, String messageName)
VB:   Sub InitializeResponseMessage(channel As IChannel, interfaceName As String, messageName As String)


Parameters:

  • channel:
  • interfaceName:
  • messageName:


InitializeResponseMessage (IChannel, String, String, String)     (declared in Message)



Oxygene:   method InitializeResponseMessage(channel: IChannel; libraryName: String; interfaceName: String; messageName: String)
C#:   void InitializeResponseMessage(IChannel channel, String libraryName, String interfaceName, String messageName)
VB:   Sub InitializeResponseMessage(channel As IChannel, libraryName As String, interfaceName As String, messageName As String)


Parameters:

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


ProcessException   protected     (declared in Message)



Oxygene:   method ProcessException
C#:   void ProcessException()
VB:   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.


Oxygene:   method Read(name: String; type: Type; format: StreamingFormat): Object
C#:   Object Read(String name, Type type, StreamingFormat format)
VB:   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.


Oxygene:   method ReadAnsiString(name: String): String
C#:   String ReadAnsiString(String name)
VB:   Function ReadAnsiString(name As String) As String


Parameters:

  • name:


ReadBoolean     (declared in Message)



Oxygene:   method ReadBoolean(name: String): Boolean
C#:   Boolean ReadBoolean(String name)
VB:   Function ReadBoolean(name As String) As Boolean


Parameters:

  • name:


ReadCurrency     (declared in Message)



Oxygene:   method ReadCurrency(name: String): Decimal
C#:   Decimal ReadCurrency(String name)
VB:   Function ReadCurrency(name As String) As Decimal


Parameters:

  • name:


ReadDateTime     (declared in Message)



Oxygene:   method ReadDateTime(name: String): DateTime
C#:   DateTime ReadDateTime(String name)
VB:   Function ReadDateTime(name As String) As DateTime


Parameters:

  • name:


ReadDecimal     (declared in Message)



Oxygene:   method ReadDecimal(name: String): Decimal
C#:   Decimal ReadDecimal(String name)
VB:   Function ReadDecimal(name As String) As Decimal


Parameters:

  • name:


ReadDouble     (declared in Message)



Oxygene:   method ReadDouble(name: String): Double
C#:   Double ReadDouble(String name)
VB:   Function ReadDouble(name As String) As Double


Parameters:

  • name:


ReadEnum     (declared in Message)



Oxygene:   method ReadEnum(name: String; type: Type): Enum
C#:   Enum ReadEnum(String name, Type type)
VB:   Function ReadEnum(name As String, type As Type) As Enum


Parameters:

  • name:
  • type:


ReadException

Reads the current message as an exception, then returns a new Exception instance, properly initialized with the message values.


Oxygene:   method ReadException: Exception
C#:   Exception ReadException()
VB:   Function ReadException As Exception


ReadFromStream     (declared in Message)

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


Oxygene:   method ReadFromStream(stream: Stream)
C#:   void ReadFromStream(Stream stream)
VB:   Sub ReadFromStream(stream As Stream)


Parameters:

  • stream:


ReadGuid     (declared in Message)



Oxygene:   method ReadGuid(name: String): Guid
C#:   Guid ReadGuid(String name)
VB:   Function ReadGuid(name As String) As Guid


Parameters:

  • name:


ReadInt32     (declared in Message)



Oxygene:   method ReadInt32(name: String): Int32
C#:   Int32 ReadInt32(String name)
VB:   Function ReadInt32(name As String) As Int32


Parameters:

  • name:


ReadInt64     (declared in Message)



Oxygene:   method ReadInt64(name: String): Int64
C#:   Int64 ReadInt64(String name)
VB:   Function ReadInt64(name As String) As Int64


Parameters:

  • name:


ReadUtf8String     (declared in Message)



Oxygene:   method ReadUtf8String(name: String): String
C#:   String ReadUtf8String(String name)
VB:   Function ReadUtf8String(name As String) As String


Parameters:

  • name:


ReadVariant     (declared in Message)



Oxygene:   method ReadVariant(name: String): Object
C#:   Object ReadVariant(String name)
VB:   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.


Oxygene:   method ReadWideString(name: String): String
C#:   String ReadWideString(String name)
VB:   Function ReadWideString(name As String) As String


Parameters:

  • name:


ReadXml     (declared in Message)



Oxygene:   method ReadXml(name: String): XmlNode
C#:   XmlNode ReadXml(String name)
VB:   Function ReadXml(name As String) As XmlNode


Parameters:

  • name:


SetAttributes     (declared in Message)



Oxygene:   method SetAttributes(channel: IChannel; attributeNames: array of String; attributeValues: array of String)
C#:   void SetAttributes(IChannel channel, array of String attributeNames, array of String attributeValues)
VB:   Sub SetAttributes(channel As IChannel, attributeNames As array of String, attributeValues As array of String)


Parameters:

  • channel:
  • attributeNames:
  • attributeValues:


TriggerAfterReadMessageParam (String, Object)   protected     (declared in Message)



Oxygene:   method TriggerAfterReadMessageParam(name: String; parameter: Object)
C#:   void TriggerAfterReadMessageParam(String name, Object parameter)
VB:   Sub TriggerAfterReadMessageParam(name As String, parameter As Object)


Parameters:

  • name:
  • parameter:


TriggerAfterReadMessageParam (String, Object, Type)   protected     (declared in Message)



Oxygene:   method TriggerAfterReadMessageParam(name: String; parameter: Object; type: Type)
C#:   void TriggerAfterReadMessageParam(String name, Object parameter, Type type)
VB:   Sub TriggerAfterReadMessageParam(name As String, parameter As Object, type As Type)


Parameters:

  • name:
  • parameter:
  • type:


TriggerAfterReadMessageParam (String, Object, Type, StreamingFormat)   protected     (declared in Message)



Oxygene:   method TriggerAfterReadMessageParam(name: String; parameter: Object; type: Type; format: StreamingFormat)
C#:   void TriggerAfterReadMessageParam(String name, Object parameter, Type type, StreamingFormat format)
VB:   Sub TriggerAfterReadMessageParam(name As String, parameter As Object, type As Type, format As StreamingFormat)


Parameters:

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


TriggerAfterUnwrapEnvelopes   protected     (declared in Message)



Oxygene:   method TriggerAfterUnwrapEnvelopes(stream: Stream)
C#:   void TriggerAfterUnwrapEnvelopes(Stream stream)
VB:   Sub TriggerAfterUnwrapEnvelopes(stream As Stream)


Parameters:

  • stream:


TriggerAfterWrapEnvelopes   protected     (declared in Message)



Oxygene:   method TriggerAfterWrapEnvelopes(stream: Stream)
C#:   void TriggerAfterWrapEnvelopes(Stream stream)
VB:   Sub TriggerAfterWrapEnvelopes(stream As Stream)


Parameters:

  • stream:


TriggerBeforeUnwrapEnvelopes   protected     (declared in Message)



Oxygene:   method TriggerBeforeUnwrapEnvelopes(stream: Stream)
C#:   void TriggerBeforeUnwrapEnvelopes(Stream stream)
VB:   Sub TriggerBeforeUnwrapEnvelopes(stream As Stream)


Parameters:

  • stream:


TriggerBeforeWrapEnvelopes   protected     (declared in Message)



Oxygene:   method TriggerBeforeWrapEnvelopes(stream: Stream)
C#:   void TriggerBeforeWrapEnvelopes(Stream stream)
VB:   Sub TriggerBeforeWrapEnvelopes(stream As Stream)


Parameters:

  • stream:


TriggerBeforeWriteMessageParam (String, Object)   protected     (declared in Message)



Oxygene:   method TriggerBeforeWriteMessageParam(name: String; parameter: Object)
C#:   void TriggerBeforeWriteMessageParam(String name, Object parameter)
VB:   Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object)


Parameters:

  • name:
  • parameter:


TriggerBeforeWriteMessageParam (String, Object, Type)   protected     (declared in Message)



Oxygene:   method TriggerBeforeWriteMessageParam(name: String; parameter: Object; type: Type)
C#:   void TriggerBeforeWriteMessageParam(String name, Object parameter, Type type)
VB:   Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object, type As Type)


Parameters:

  • name:
  • parameter:
  • type:


TriggerBeforeWriteMessageParam (String, Object, Type, StreamingFormat)   protected     (declared in Message)



Oxygene:   method TriggerBeforeWriteMessageParam(name: String; parameter: Object; type: Type; format: StreamingFormat)
C#:   void TriggerBeforeWriteMessageParam(String name, Object parameter, Type type, StreamingFormat format)
VB:   Sub TriggerBeforeWriteMessageParam(name As String, parameter As Object, type As Type, format As StreamingFormat)


Parameters:

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


TriggerOnFinalizeMessage   protected     (declared in Message)



Oxygene:   method TriggerOnFinalizeMessage
C#:   void TriggerOnFinalizeMessage()
VB:   Sub TriggerOnFinalizeMessage


TriggerOnInitializeMessage   protected     (declared in Message)



Oxygene:   method TriggerOnInitializeMessage(channel: IChannel; interfaceName: String; messageName: String; exception: Exception)
C#:   void TriggerOnInitializeMessage(IChannel channel, String interfaceName, String messageName, Exception exception)
VB:   Sub TriggerOnInitializeMessage(channel As IChannel, interfaceName As String, messageName As String, exception As Exception)


Parameters:

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


UnwrapEnvelopes   protected     (declared in Message)



Oxygene:   method UnwrapEnvelopes(stream: Stream): Stream
C#:   Stream UnwrapEnvelopes(Stream stream)
VB:   Function UnwrapEnvelopes(stream As Stream) As Stream


Parameters:

  • stream:


Validate

Checks if specified string begins with "RO" substring


Oxygene:   method Validate(content: String): Boolean
C#:   Boolean Validate(String content)
VB:   Function Validate(content As String) As Boolean


Parameters:

  • content: content to validate


WrapEnvelopes   protected     (declared in Message)



Oxygene:   method WrapEnvelopes(stream: Stream): Stream
C#:   Stream WrapEnvelopes(Stream stream)
VB:   Function WrapEnvelopes(stream As Stream) As Stream


Parameters:

  • stream:


Write     (declared in Message)



Oxygene:   method Write(name: String; value: Object; type: Type; format: StreamingFormat)
C#:   void Write(String name, Object value, Type type, StreamingFormat format)
VB:   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.


Oxygene:   method WriteAnsiString(name: String; value: String)
C#:   void WriteAnsiString(String name, String value)
VB:   Sub WriteAnsiString(name As String, value As String)


Parameters:

  • name:
  • value:


WriteBoolean     (declared in Message)



Oxygene:   method WriteBoolean(name: String; value: Boolean)
C#:   void WriteBoolean(String name, Boolean value)
VB:   Sub WriteBoolean(name As String, value As Boolean)


Parameters:

  • name:
  • value:


WriteCurrency     (declared in Message)



Oxygene:   method WriteCurrency(name: String; value: Decimal)
C#:   void WriteCurrency(String name, Decimal value)
VB:   Sub WriteCurrency(name As String, value As Decimal)


Parameters:

  • name:
  • value:


WriteDateTime     (declared in Message)



Oxygene:   method WriteDateTime(name: String; value: DateTime)
C#:   void WriteDateTime(String name, DateTime value)
VB:   Sub WriteDateTime(name As String, value As DateTime)


Parameters:

  • name:
  • value:


WriteDecimal     (declared in Message)



Oxygene:   method WriteDecimal(name: String; value: Decimal)
C#:   void WriteDecimal(String name, Decimal value)
VB:   Sub WriteDecimal(name As String, value As Decimal)


Parameters:

  • name:
  • value:


WriteDouble     (declared in Message)



Oxygene:   method WriteDouble(name: String; value: Double)
C#:   void WriteDouble(String name, Double value)
VB:   Sub WriteDouble(name As String, value As Double)


Parameters:

  • name:
  • value:


WriteEnum     (declared in Message)



Oxygene:   method WriteEnum(name: String; value: Enum)
C#:   void WriteEnum(String name, Enum value)
VB:   Sub WriteEnum(name As String, value As Enum)


Parameters:

  • name:
  • value:


WriteEnvelopeHeader     (declared in Message)



Oxygene:   method WriteEnvelopeHeader(envelope: MessageEnvelope; stream: Stream)
C#:   void WriteEnvelopeHeader(MessageEnvelope envelope, Stream stream)
VB:   Sub WriteEnvelopeHeader(envelope As MessageEnvelope, stream As Stream)


Parameters:

  • envelope:
  • stream:


WriteException

Writes the given exception to the message.


Oxygene:   method WriteException(exception: Exception)
C#:   void WriteException(Exception exception)
VB:   Sub WriteException(exception As Exception)


Parameters:

  • exception:


WriteGuid     (declared in Message)



Oxygene:   method WriteGuid(name: String; value: Guid)
C#:   void WriteGuid(String name, Guid value)
VB:   Sub WriteGuid(name As String, value As Guid)


Parameters:

  • name:
  • value:


WriteInt32     (declared in Message)



Oxygene:   method WriteInt32(name: String; value: Int32)
C#:   void WriteInt32(String name, Int32 value)
VB:   Sub WriteInt32(name As String, value As Int32)


Parameters:

  • name:
  • value:


WriteInt64     (declared in Message)



Oxygene:   method WriteInt64(name: String; value: Int64)
C#:   void WriteInt64(String name, Int64 value)
VB:   Sub WriteInt64(name As String, value As Int64)


Parameters:

  • name:
  • value:


WriteToStream (MessageType, Stream)

Writes the given stream to the message.


Oxygene:   method WriteToStream(messageType: MessageType; stream: Stream)
C#:   void WriteToStream(MessageType messageType, Stream stream)
VB:   Sub WriteToStream(messageType As MessageType, stream As Stream)


Parameters:

  • messageType:
  • stream:


WriteToStream (Stream)     (declared in Message)



Oxygene:   method WriteToStream(stream: Stream)
C#:   void WriteToStream(Stream stream)
VB:   Sub WriteToStream(stream As Stream)


Parameters:

  • stream:


WriteUtf8String     (declared in Message)



Oxygene:   method WriteUtf8String(name: String; value: String)
C#:   void WriteUtf8String(String name, String value)
VB:   Sub WriteUtf8String(name As String, value As String)


Parameters:

  • name:
  • value:


WriteVariant     (declared in Message)



Oxygene:   method WriteVariant(name: String; value: Object)
C#:   void WriteVariant(String name, Object value)
VB:   Sub WriteVariant(name As String, value As Object)


Parameters:

  • name:
  • value:


WriteWideString     (declared in Message)



Oxygene:   method WriteWideString(name: String; value: String)
C#:   void WriteWideString(String name, String value)
VB:   Sub WriteWideString(name As String, value As String)


Parameters:

  • name:
  • value:


WriteXml     (declared in Message)



Oxygene:   method WriteXml(name: String; value: XmlNode)
C#:   void WriteXml(String name, XmlNode value)
VB:   Sub WriteXml(name As String, value As XmlNode)


Parameters:

  • name:
  • value:


Events

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.



Oxygene:   event AfterReadMessageParam: EventHandler<MessageParamEventArgs>
C#:   event EventHandler<MessageParamEventArgs> AfterReadMessageParam
VB:   Event AfterReadMessageParam As EventHandler<MessageParamEventArgs>


AfterUnwrapEnvelopes     (declared in Message)



Oxygene:   event AfterUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
C#:   event EventHandler<StreamOperationEventArgs> AfterUnwrapEnvelopes
VB:   Event AfterUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>


AfterWrapEnvelopes     (declared in Message)



Oxygene:   event AfterWrapEnvelopes: EventHandler<StreamOperationEventArgs>
C#:   event EventHandler<StreamOperationEventArgs> AfterWrapEnvelopes
VB:   Event AfterWrapEnvelopes As EventHandler<StreamOperationEventArgs>


BeforeUnwrapEnvelopes     (declared in Message)



Oxygene:   event BeforeUnwrapEnvelopes: EventHandler<StreamOperationEventArgs>
C#:   event EventHandler<StreamOperationEventArgs> BeforeUnwrapEnvelopes
VB:   Event BeforeUnwrapEnvelopes As EventHandler<StreamOperationEventArgs>


BeforeWrapEnvelopes     (declared in Message)



Oxygene:   event BeforeWrapEnvelopes: EventHandler<StreamOperationEventArgs>
C#:   event EventHandler<StreamOperationEventArgs> BeforeWrapEnvelopes
VB:   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.



Oxygene:   event BeforeWriteMessageParam: EventHandler<MessageParamEventArgs>
C#:   event EventHandler<MessageParamEventArgs> BeforeWriteMessageParam
VB:   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.



Oxygene:   event OnFinalizeMessage: EventHandler<EventArgs>
C#:   event EventHandler<EventArgs> OnFinalizeMessage
VB:   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.



Oxygene:   event OnInitializeMessage: EventHandler<InitMessageEventArgs>
C#:   event EventHandler<InitMessageEventArgs> OnInitializeMessage
VB:   Event OnInitializeMessage As EventHandler<InitMessageEventArgs>


See Also


Product: RemObjects SDK
Available Editions: RemObjects SDK for .NET, Xcode, Delphi, Java and JavaScript

Glossary — Articles — Library — Samples

Retrieved from "http://wiki.remobjects.com/w/index.php?title=BinMessage_Class_(.NET)&oldid=84295"
Personal tools
Namespaces

Variants
Actions
Navigation
products
platforms
special
Toolbox