BinMessage

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.

Location


 

constructor

Creates BinMessage.

 

constructor

 

BinMessage()

beginReadObject

Calls to read instance of ComplexType.

 

method beginReadObject(aName: String; aValue: Class): ComplexType

 

ComplexType beginReadObject(String aName, Class aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given subclass of ComplexType class.

beginWriteObject

Calls to write instance of ComplexType.

 

method beginWriteObject(aName: String; aValue: ComplexType)

 

void beginWriteObject(String aName, ComplexType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given ComplexType object.

clear

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

 

method clear

 

void clear()

clearAttributes

Do nothing.

 

method clearAttributes

 

void clearAttributes()

ClientID

 

property ClientID: UUID read write;

 

UUID ClientID { __get; __set; }

clone

Creates copy of the message.

 

method clone: Object

 

Object clone()

ContentType

 

property ContentType: String read;

 

String ContentType { __get; }

createExceptionWithClassName    (declared in Message)

Creates exception object.

 

method createExceptionWithClassName(aExceptionName: String; aMessage: String): ExceptionType

 

ExceptionType createExceptionWithClassName(String aExceptionName, String aMessage)

Parameters:

  • aExceptionName: Given exception class name.
  • aMessage: Given exception text.

doGetStream

Creates a new stream with the content of the message.

 

method doGetStream: ByteArrayOutputStream

 

ByteArrayOutputStream doGetStream()

doReadException  final    (declared in Message)

Calls to read exception params from stream.

 

method doReadException(aException: ExceptionType)

 

void doReadException(ExceptionType aException)

Parameters:

  • aException: Given exception.

doReadFromStream

Reads from input stream the BinHeader and the BinReaderWriter streams.

 

method doReadFromStream(aStream: ByteArrayInputStream)

 

void doReadFromStream(ByteArrayInputStream aStream)

Parameters:

  • aStream: Incoming stream.

doReadObject  final    (declared in Message)

Calls to read ComplexType elements.

 

method doReadObject(aName: String; aValue: IStreamable)

 

void doReadObject(String aName, IStreamable aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

doWriteObject  final    (declared in Message)

Calls to write ComplexType elements.

 

method doWriteObject(aName: String; aValue: IStreamable)

 

void doWriteObject(String aName, IStreamable aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

endReadObject

Do nothing.

 

method endReadObject(aName: String; aValue: ComplexType)

 

void endReadObject(String aName, ComplexType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Ignored. Can be nil.

endWriteObject

Do nothing.

 

method endWriteObject(aName: String; aValue: ComplexType)

 

void endWriteObject(String aName, ComplexType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Ignored. Can be nil.

EnforceMaxMessageSize

Gets or sets a flag indicating whether the incoming messages will be checked to conform to the restrictions applied by the MaxMessageSize and MaxDecompressedMessageSize properties.

The default value is true

 

property EnforceMaxMessageSize: Boolean read write;

 

Boolean EnforceMaxMessageSize { __get; __set; }

Envelopes    (declared in Message)

 

property Envelopes: HashMap<String, MessageEnvelope> read;

 

HashMap<String, MessageEnvelope> Envelopes { __get; }

finalizeMessage

Do nothing.

 

method finalizeMessage

 

void finalizeMessage()

getAtttributeValue

Do nothing.

 

method getAtttributeValue(aName: String): String

 

String getAtttributeValue(String aName)

Parameters:

  • aName: Ignored. Can be nil.

getStream  final    (declared in Message)

This method provides envelopes processing.

 

method getStream: ByteArrayOutputStream

 

ByteArrayOutputStream getStream()

initializeAsRequestMessage  final    (declared in Message)

Initializes request message.

 

method initializeAsRequestMessage(aLibraryName: String; anInterfaceName: String; aMessageName: String)

 

void initializeAsRequestMessage(String aLibraryName, String anInterfaceName, String aMessageName)

Parameters:

  • aLibraryName: Given name.
  • anInterfaceName: Given name.
  • aMessageName: Given name.

initializeMessage

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

 

method initializeMessage(aLibraryName: String; anInterfaceName: String; aMessageName: String; aMessageType: MessageTypeDictionary)

 

void initializeMessage(String aLibraryName, String anInterfaceName, String aMessageName, MessageTypeDictionary aMessageType)

Parameters:

  • aLibraryName: Given library name.
  • anInterfaceName: Given interface name.
  • aMessageName: Given message name.
  • aMessageType: Given message type.

InterfaceName    (declared in Message)

 

property InterfaceName: String read write;

 

String InterfaceName { __get; __set; }

LibraryName    (declared in Message)

 

property LibraryName: String read write;

 

String LibraryName { __get; __set; }

MaxDecompressedMessageSize

Gets or sets the maximum message size (after decompression) to be received.

If the EnforceMaxMessageSize property is set to true and the size of received message exceeds the value of this property then an exception will be raised.

 

property MaxDecompressedMessageSize: Integer read write;

 

Integer MaxDecompressedMessageSize { __get; __set; }

MaxMessageSize

Gets or sets the maximum message size to be received.

 

property MaxMessageSize: Integer read write;

 

Integer MaxMessageSize { __get; __set; }

MessageName    (declared in Message)

 

property MessageName: String read write;

 

String MessageName { __get; __set; }

MessageType    (declared in Message)

 

property MessageType: MessageTypeDictionary read write;

 

MessageTypeDictionary MessageType { __get; __set; }

MessageVersion

 

property MessageVersion: Integer read;

 

Integer MessageVersion { __get; }

messageWithURI    (declared in Message)

Static method factory. Creates message by URI scheme.

 

class method messageWithURI(aURI: URI): Message

 

static Message messageWithURI(URI aURI)

Parameters:

  • aURI: Given URI.

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 an only slightly smaller packet on the network.

 

property MinSizeForCompression: Integer read write;

 

Integer MinSizeForCompression { __get; __set; }

processException  final    (declared in Message)

Raises exception from server.

 

method processException

 

void processException()

readAnsiString

Calls to read ANSI string.

 

method readAnsiString(aName: String): String

 

String readAnsiString(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readArray

Calls to read ArrayType.

 

method readArray(aName: String; aValue: Class): ArrayType

 

ArrayType readArray(String aName, Class aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given subclass of ArrayType class.

readBinary

Calls to read binary stream.

 

method readBinary(aName: String): array of SByte

 

SByte[] readBinary(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readBoolean

Calls to read boolean.

 

method readBoolean(aName: String): Boolean

 

Boolean readBoolean(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readByte

Calls to read byte.

 

method readByte(aName: String): Byte

 

Byte readByte(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readComplex    (declared in Message)

Calls to read struct.

 

method readComplex(aName: String; aValue: Class): ComplexType

 

ComplexType readComplex(String aName, Class aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

readCurrency

Calls to read currency.

 

method readCurrency(aName: String): BigDecimal

 

BigDecimal readCurrency(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readDateTime

Calls to read date.

 

method readDateTime(aName: String): Date

 

Date readDateTime(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readDecimal

Calls to read decimal.

 

method readDecimal(aName: String): BigDecimal

 

BigDecimal readDecimal(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readDouble

Calls to read double.

 

method readDouble(aName: String): Double

 

Double readDouble(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readEnum

Calls to read enum.

 

method readEnum(aName: String): Integer

 

Integer readEnum(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readException

Calls to read and raise exception.

 

method readException: ExceptionType

 

ExceptionType readException()

readFromStream  final    (declared in Message)

For internal use, used by the RO/J framework to stream objects to a message packet.

 

method readFromStream(aStream: ByteArrayInputStream)

 

void readFromStream(ByteArrayInputStream aStream)

Parameters:

  • aStream: Given stream.

readGuid

Calls to read uuid.

 

method readGuid(aName: String): UUID

 

UUID readGuid(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readInt32

Calls to read integer.

 

method readInt32(aName: String): Integer

 

Integer readInt32(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readInt64

Calls to read long.

 

method readInt64(aName: String): Long

 

Long readInt64(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readNativeArray

 

method readNativeArray(aName: String; aValue: Class; aRodlType: String): array of Object

 

Object[] readNativeArray(String aName, Class aValue, String aRodlType)

Parameters:

  • aName:
  • aValue:
  • aRodlType:

readNullableBoolean

 

method readNullableBoolean(aName: String): Boolean

 

Boolean readNullableBoolean(String aName)

Parameters:

  • aName:

readNullableCurrency

 

method readNullableCurrency(aName: String): nullable BigDecimal

 

BigDecimal readNullableCurrency(String aName)

Parameters:

  • aName:

readNullableDateTime

 

method readNullableDateTime(aName: String): nullable Date

 

Date readNullableDateTime(String aName)

Parameters:

  • aName:

readNullableDecimal

 

method readNullableDecimal(aName: String): nullable BigDecimal

 

BigDecimal readNullableDecimal(String aName)

Parameters:

  • aName:

readNullableDouble

 

method readNullableDouble(aName: String): Double

 

Double readNullableDouble(String aName)

Parameters:

  • aName:

readNullableGuid

 

method readNullableGuid(aName: String): nullable UUID

 

UUID readNullableGuid(String aName)

Parameters:

  • aName:

readNullableInt32

 

method readNullableInt32(aName: String): Integer

 

Integer readNullableInt32(String aName)

Parameters:

  • aName:

readNullableInt64

 

method readNullableInt64(aName: String): Long

 

Long readNullableInt64(String aName)

Parameters:

  • aName:

readUtf8String

Calls to read UTF8 string.

 

method readUtf8String(aName: String): String

 

String readUtf8String(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readVariant (String): VariantType    (declared in Message)

Call to this method to read VariantType.

 

method readVariant(aName: String): VariantType

 

VariantType readVariant(String aName)

Parameters:

  • aName: Given name.

readVariant (String): VariantType

 

method readVariant(name: String): VariantType

 

VariantType readVariant(String name)

Parameters:

  • name:

readWideString

Calls to read wide string.

 

method readWideString(aName: String): String

 

String readWideString(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readXml

Calls to read XmlType.

 

method readXml(aName: String): XmlType

 

XmlType readXml(String aName)

Parameters:

  • aName: Ignored. Can be nil.

setupAttributes

Do nothing.

 

method setupAttributes(aAttributes: HashMap<String, String>)

 

void setupAttributes(HashMap<String, String> aAttributes)

Parameters:

  • aAttributes: Ignored. Can be nil.

UseCompression

 

property UseCompression: Boolean read write;

 

Boolean UseCompression { __get; __set; }

UseSingleClientID    (declared in Message)

 

class property UseSingleClientID: Boolean read write;

 

class Boolean UseSingleClientID { __get; __set; }

UseStrictFieldOrderForStructs    (declared in Message)

 

property UseStrictFieldOrderForStructs: Boolean read write;

 

Boolean UseStrictFieldOrderForStructs { __get; __set; }

writeAnsiString

Calls to write ANSI string.

 

method writeAnsiString(aName: String; aValue: String)

 

void writeAnsiString(String aName, String aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeArray

Calls to write instance of ArrayType.

 

method writeArray(aName: String; aValue: ArrayType)

 

void writeArray(String aName, ArrayType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeBinary

Calls to write binary stream.

 

method writeBinary(aName: String; aValue: array of SByte)

 

void writeBinary(String aName, SByte[] aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeBoolean

Calls to write boolean.

 

method writeBoolean(aName: String; aValue: Boolean)

 

void writeBoolean(String aName, Boolean aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeByte

Calls to write byte.

 

method writeByte(aName: String; aValue: Byte)

 

void writeByte(String aName, Byte aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeComplex  final    (declared in Message)

Calls to write currency.

 

method writeComplex(aName: String; aValue: ComplexType)

 

void writeComplex(String aName, ComplexType aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

writeCurrency

Calls to write currency.

 

method writeCurrency(aName: String; aValue: BigDecimal)

 

void writeCurrency(String aName, BigDecimal aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeDateTime

Calls to write date.

 

method writeDateTime(aName: String; aValue: Date)

 

void writeDateTime(String aName, Date aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeDecimal

Calls to write decimal.

 

method writeDecimal(aName: String; aValue: BigDecimal)

 

void writeDecimal(String aName, BigDecimal aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeDouble

Calls to write double.

 

method writeDouble(aName: String; aValue: Double)

 

void writeDouble(String aName, Double aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeEnum

Calls to write enum.

 

method writeEnum(aName: String; aValue: Integer)

 

void writeEnum(String aName, Integer aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeGuid

Calls to write uuid.

 

method writeGuid(aName: String; aValue: UUID)

 

void writeGuid(String aName, UUID aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeInt32

Calls to write integer.

 

method writeInt32(aName: String; aValue: Integer)

 

void writeInt32(String aName, Integer aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeInt64

Calls to write long.

 

method writeInt64(aName: String; aValue: Long)

 

void writeInt64(String aName, Long aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeNativeArray

 

method writeNativeArray(aName: String; aValue: array of Object; aRodlType: String)

 

void writeNativeArray(String aName, Object[] aValue, String aRodlType)

Parameters:

  • aName:
  • aValue:
  • aRodlType:

writeNullableBoolean

 

method writeNullableBoolean(aName: String; aValue: Boolean)

 

void writeNullableBoolean(String aName, Boolean aValue)

Parameters:

  • aName:
  • aValue:

writeNullableCurrency

 

method writeNullableCurrency(aName: String; aValue: nullable BigDecimal)

 

void writeNullableCurrency(String aName, BigDecimal aValue)

Parameters:

  • aName:
  • aValue:

writeNullableDateTime

 

method writeNullableDateTime(aName: String; aValue: nullable Date)

 

void writeNullableDateTime(String aName, Date aValue)

Parameters:

  • aName:
  • aValue:

writeNullableDecimal

 

method writeNullableDecimal(aName: String; aValue: nullable BigDecimal)

 

void writeNullableDecimal(String aName, BigDecimal aValue)

Parameters:

  • aName:
  • aValue:

writeNullableDouble

 

method writeNullableDouble(aName: String; aValue: Double)

 

void writeNullableDouble(String aName, Double aValue)

Parameters:

  • aName:
  • aValue:

writeNullableGuid

 

method writeNullableGuid(aName: String; aValue: nullable UUID)

 

void writeNullableGuid(String aName, UUID aValue)

Parameters:

  • aName:
  • aValue:

writeNullableInt32

 

method writeNullableInt32(aName: String; aValue: Integer)

 

void writeNullableInt32(String aName, Integer aValue)

Parameters:

  • aName:
  • aValue:

writeNullableInt64

 

method writeNullableInt64(aName: String; aValue: Long)

 

void writeNullableInt64(String aName, Long aValue)

Parameters:

  • aName:
  • aValue:

writeToStream  final    (declared in Message)

For internal use, used by the RO/J framework to stream objects to a message packet.

 

method writeToStream(aStream: ByteArrayOutputStream)

 

void writeToStream(ByteArrayOutputStream aStream)

Parameters:

  • aStream: Given stream.

writeUtf8String

Calls to write UTF8 string.

 

method writeUtf8String(aName: String; aValue: String)

 

void writeUtf8String(String aName, String aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeVariant (String, VariantType)    (declared in Message)

Calls to write VariantType.

 

method writeVariant(aName: String; aValue: VariantType)

 

void writeVariant(String aName, VariantType aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

writeVariant (String, VariantType)

 

method writeVariant(name: String; value: VariantType)

 

void writeVariant(String name, VariantType value)

Parameters:

  • name:
  • value:

writeWideString

Calls to write wide string.

 

method writeWideString(aName: String; aValue: String)

 

void writeWideString(String aName, String aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeXml

Calls to write XmlType.

 

method writeXml(aName: String; aValue: XmlType)

 

void writeXml(String aName, XmlType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

 

ClientID

 

property ClientID: UUID read write;

 

UUID ClientID { __get; __set; }

ContentType

 

property ContentType: String read;

 

String ContentType { __get; }

EnforceMaxMessageSize

Gets or sets a flag indicating whether the incoming messages will be checked to conform to the restrictions applied by the MaxMessageSize and MaxDecompressedMessageSize properties.

The default value is true

 

property EnforceMaxMessageSize: Boolean read write;

 

Boolean EnforceMaxMessageSize { __get; __set; }

Envelopes    (declared in Message)

 

property Envelopes: HashMap<String, MessageEnvelope> read;

 

HashMap<String, MessageEnvelope> Envelopes { __get; }

InterfaceName    (declared in Message)

 

property InterfaceName: String read write;

 

String InterfaceName { __get; __set; }

LibraryName    (declared in Message)

 

property LibraryName: String read write;

 

String LibraryName { __get; __set; }

MaxDecompressedMessageSize

Gets or sets the maximum message size (after decompression) to be received.

If the EnforceMaxMessageSize property is set to true and the size of received message exceeds the value of this property then an exception will be raised.

 

property MaxDecompressedMessageSize: Integer read write;

 

Integer MaxDecompressedMessageSize { __get; __set; }

MaxMessageSize

Gets or sets the maximum message size to be received.

 

property MaxMessageSize: Integer read write;

 

Integer MaxMessageSize { __get; __set; }

MessageName    (declared in Message)

 

property MessageName: String read write;

 

String MessageName { __get; __set; }

MessageType    (declared in Message)

 

property MessageType: MessageTypeDictionary read write;

 

MessageTypeDictionary MessageType { __get; __set; }

MessageVersion

 

property MessageVersion: Integer read;

 

Integer MessageVersion { __get; }

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 an only slightly smaller packet on the network.

 

property MinSizeForCompression: Integer read write;

 

Integer MinSizeForCompression { __get; __set; }

UseCompression

 

property UseCompression: Boolean read write;

 

Boolean UseCompression { __get; __set; }

UseStrictFieldOrderForStructs    (declared in Message)

 

property UseStrictFieldOrderForStructs: Boolean read write;

 

Boolean UseStrictFieldOrderForStructs { __get; __set; }

UseSingleClientID    (declared in Message)

 

class property UseSingleClientID: Boolean read write;

 

class Boolean UseSingleClientID { __get; __set; }

 

messageWithURI    (declared in Message)

Static method factory. Creates message by URI scheme.

 

class method messageWithURI(aURI: URI): Message

 

static Message messageWithURI(URI aURI)

Parameters:

  • aURI: Given URI.

 

constructor

Creates BinMessage.

 

constructor

 

BinMessage()

beginReadObject

Calls to read instance of ComplexType.

 

method beginReadObject(aName: String; aValue: Class): ComplexType

 

ComplexType beginReadObject(String aName, Class aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given subclass of ComplexType class.

beginWriteObject

Calls to write instance of ComplexType.

 

method beginWriteObject(aName: String; aValue: ComplexType)

 

void beginWriteObject(String aName, ComplexType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given ComplexType object.

clear

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

 

method clear

 

void clear()

clearAttributes

Do nothing.

 

method clearAttributes

 

void clearAttributes()

clone

Creates copy of the message.

 

method clone: Object

 

Object clone()

createExceptionWithClassName    (declared in Message)

Creates exception object.

 

method createExceptionWithClassName(aExceptionName: String; aMessage: String): ExceptionType

 

ExceptionType createExceptionWithClassName(String aExceptionName, String aMessage)

Parameters:

  • aExceptionName: Given exception class name.
  • aMessage: Given exception text.

doGetStream

Creates a new stream with the content of the message.

 

method doGetStream: ByteArrayOutputStream

 

ByteArrayOutputStream doGetStream()

doReadException  final    (declared in Message)

Calls to read exception params from stream.

 

method doReadException(aException: ExceptionType)

 

void doReadException(ExceptionType aException)

Parameters:

  • aException: Given exception.

doReadFromStream

Reads from input stream the BinHeader and the BinReaderWriter streams.

 

method doReadFromStream(aStream: ByteArrayInputStream)

 

void doReadFromStream(ByteArrayInputStream aStream)

Parameters:

  • aStream: Incoming stream.

doReadObject  final    (declared in Message)

Calls to read ComplexType elements.

 

method doReadObject(aName: String; aValue: IStreamable)

 

void doReadObject(String aName, IStreamable aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

doWriteObject  final    (declared in Message)

Calls to write ComplexType elements.

 

method doWriteObject(aName: String; aValue: IStreamable)

 

void doWriteObject(String aName, IStreamable aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

endReadObject

Do nothing.

 

method endReadObject(aName: String; aValue: ComplexType)

 

void endReadObject(String aName, ComplexType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Ignored. Can be nil.

endWriteObject

Do nothing.

 

method endWriteObject(aName: String; aValue: ComplexType)

 

void endWriteObject(String aName, ComplexType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Ignored. Can be nil.

finalizeMessage

Do nothing.

 

method finalizeMessage

 

void finalizeMessage()

getAtttributeValue

Do nothing.

 

method getAtttributeValue(aName: String): String

 

String getAtttributeValue(String aName)

Parameters:

  • aName: Ignored. Can be nil.

getStream  final    (declared in Message)

This method provides envelopes processing.

 

method getStream: ByteArrayOutputStream

 

ByteArrayOutputStream getStream()

initializeAsRequestMessage  final    (declared in Message)

Initializes request message.

 

method initializeAsRequestMessage(aLibraryName: String; anInterfaceName: String; aMessageName: String)

 

void initializeAsRequestMessage(String aLibraryName, String anInterfaceName, String aMessageName)

Parameters:

  • aLibraryName: Given name.
  • anInterfaceName: Given name.
  • aMessageName: Given name.

initializeMessage

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

 

method initializeMessage(aLibraryName: String; anInterfaceName: String; aMessageName: String; aMessageType: MessageTypeDictionary)

 

void initializeMessage(String aLibraryName, String anInterfaceName, String aMessageName, MessageTypeDictionary aMessageType)

Parameters:

  • aLibraryName: Given library name.
  • anInterfaceName: Given interface name.
  • aMessageName: Given message name.
  • aMessageType: Given message type.

processException  final    (declared in Message)

Raises exception from server.

 

method processException

 

void processException()

readAnsiString

Calls to read ANSI string.

 

method readAnsiString(aName: String): String

 

String readAnsiString(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readArray

Calls to read ArrayType.

 

method readArray(aName: String; aValue: Class): ArrayType

 

ArrayType readArray(String aName, Class aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given subclass of ArrayType class.

readBinary

Calls to read binary stream.

 

method readBinary(aName: String): array of SByte

 

SByte[] readBinary(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readBoolean

Calls to read boolean.

 

method readBoolean(aName: String): Boolean

 

Boolean readBoolean(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readByte

Calls to read byte.

 

method readByte(aName: String): Byte

 

Byte readByte(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readComplex    (declared in Message)

Calls to read struct.

 

method readComplex(aName: String; aValue: Class): ComplexType

 

ComplexType readComplex(String aName, Class aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

readCurrency

Calls to read currency.

 

method readCurrency(aName: String): BigDecimal

 

BigDecimal readCurrency(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readDateTime

Calls to read date.

 

method readDateTime(aName: String): Date

 

Date readDateTime(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readDecimal

Calls to read decimal.

 

method readDecimal(aName: String): BigDecimal

 

BigDecimal readDecimal(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readDouble

Calls to read double.

 

method readDouble(aName: String): Double

 

Double readDouble(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readEnum

Calls to read enum.

 

method readEnum(aName: String): Integer

 

Integer readEnum(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readException

Calls to read and raise exception.

 

method readException: ExceptionType

 

ExceptionType readException()

readFromStream  final    (declared in Message)

For internal use, used by the RO/J framework to stream objects to a message packet.

 

method readFromStream(aStream: ByteArrayInputStream)

 

void readFromStream(ByteArrayInputStream aStream)

Parameters:

  • aStream: Given stream.

readGuid

Calls to read uuid.

 

method readGuid(aName: String): UUID

 

UUID readGuid(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readInt32

Calls to read integer.

 

method readInt32(aName: String): Integer

 

Integer readInt32(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readInt64

Calls to read long.

 

method readInt64(aName: String): Long

 

Long readInt64(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readNativeArray

 

method readNativeArray(aName: String; aValue: Class; aRodlType: String): array of Object

 

Object[] readNativeArray(String aName, Class aValue, String aRodlType)

Parameters:

  • aName:
  • aValue:
  • aRodlType:

readNullableBoolean

 

method readNullableBoolean(aName: String): Boolean

 

Boolean readNullableBoolean(String aName)

Parameters:

  • aName:

readNullableCurrency

 

method readNullableCurrency(aName: String): nullable BigDecimal

 

BigDecimal readNullableCurrency(String aName)

Parameters:

  • aName:

readNullableDateTime

 

method readNullableDateTime(aName: String): nullable Date

 

Date readNullableDateTime(String aName)

Parameters:

  • aName:

readNullableDecimal

 

method readNullableDecimal(aName: String): nullable BigDecimal

 

BigDecimal readNullableDecimal(String aName)

Parameters:

  • aName:

readNullableDouble

 

method readNullableDouble(aName: String): Double

 

Double readNullableDouble(String aName)

Parameters:

  • aName:

readNullableGuid

 

method readNullableGuid(aName: String): nullable UUID

 

UUID readNullableGuid(String aName)

Parameters:

  • aName:

readNullableInt32

 

method readNullableInt32(aName: String): Integer

 

Integer readNullableInt32(String aName)

Parameters:

  • aName:

readNullableInt64

 

method readNullableInt64(aName: String): Long

 

Long readNullableInt64(String aName)

Parameters:

  • aName:

readUtf8String

Calls to read UTF8 string.

 

method readUtf8String(aName: String): String

 

String readUtf8String(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readVariant (String): VariantType    (declared in Message)

Call to this method to read VariantType.

 

method readVariant(aName: String): VariantType

 

VariantType readVariant(String aName)

Parameters:

  • aName: Given name.

readVariant (String): VariantType

 

method readVariant(name: String): VariantType

 

VariantType readVariant(String name)

Parameters:

  • name:

readWideString

Calls to read wide string.

 

method readWideString(aName: String): String

 

String readWideString(String aName)

Parameters:

  • aName: Ignored. Can be nil.

readXml

Calls to read XmlType.

 

method readXml(aName: String): XmlType

 

XmlType readXml(String aName)

Parameters:

  • aName: Ignored. Can be nil.

setupAttributes

Do nothing.

 

method setupAttributes(aAttributes: HashMap<String, String>)

 

void setupAttributes(HashMap<String, String> aAttributes)

Parameters:

  • aAttributes: Ignored. Can be nil.

writeAnsiString

Calls to write ANSI string.

 

method writeAnsiString(aName: String; aValue: String)

 

void writeAnsiString(String aName, String aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeArray

Calls to write instance of ArrayType.

 

method writeArray(aName: String; aValue: ArrayType)

 

void writeArray(String aName, ArrayType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeBinary

Calls to write binary stream.

 

method writeBinary(aName: String; aValue: array of SByte)

 

void writeBinary(String aName, SByte[] aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeBoolean

Calls to write boolean.

 

method writeBoolean(aName: String; aValue: Boolean)

 

void writeBoolean(String aName, Boolean aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeByte

Calls to write byte.

 

method writeByte(aName: String; aValue: Byte)

 

void writeByte(String aName, Byte aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeComplex  final    (declared in Message)

Calls to write currency.

 

method writeComplex(aName: String; aValue: ComplexType)

 

void writeComplex(String aName, ComplexType aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

writeCurrency

Calls to write currency.

 

method writeCurrency(aName: String; aValue: BigDecimal)

 

void writeCurrency(String aName, BigDecimal aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeDateTime

Calls to write date.

 

method writeDateTime(aName: String; aValue: Date)

 

void writeDateTime(String aName, Date aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeDecimal

Calls to write decimal.

 

method writeDecimal(aName: String; aValue: BigDecimal)

 

void writeDecimal(String aName, BigDecimal aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeDouble

Calls to write double.

 

method writeDouble(aName: String; aValue: Double)

 

void writeDouble(String aName, Double aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeEnum

Calls to write enum.

 

method writeEnum(aName: String; aValue: Integer)

 

void writeEnum(String aName, Integer aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeGuid

Calls to write uuid.

 

method writeGuid(aName: String; aValue: UUID)

 

void writeGuid(String aName, UUID aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeInt32

Calls to write integer.

 

method writeInt32(aName: String; aValue: Integer)

 

void writeInt32(String aName, Integer aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeInt64

Calls to write long.

 

method writeInt64(aName: String; aValue: Long)

 

void writeInt64(String aName, Long aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeNativeArray

 

method writeNativeArray(aName: String; aValue: array of Object; aRodlType: String)

 

void writeNativeArray(String aName, Object[] aValue, String aRodlType)

Parameters:

  • aName:
  • aValue:
  • aRodlType:

writeNullableBoolean

 

method writeNullableBoolean(aName: String; aValue: Boolean)

 

void writeNullableBoolean(String aName, Boolean aValue)

Parameters:

  • aName:
  • aValue:

writeNullableCurrency

 

method writeNullableCurrency(aName: String; aValue: nullable BigDecimal)

 

void writeNullableCurrency(String aName, BigDecimal aValue)

Parameters:

  • aName:
  • aValue:

writeNullableDateTime

 

method writeNullableDateTime(aName: String; aValue: nullable Date)

 

void writeNullableDateTime(String aName, Date aValue)

Parameters:

  • aName:
  • aValue:

writeNullableDecimal

 

method writeNullableDecimal(aName: String; aValue: nullable BigDecimal)

 

void writeNullableDecimal(String aName, BigDecimal aValue)

Parameters:

  • aName:
  • aValue:

writeNullableDouble

 

method writeNullableDouble(aName: String; aValue: Double)

 

void writeNullableDouble(String aName, Double aValue)

Parameters:

  • aName:
  • aValue:

writeNullableGuid

 

method writeNullableGuid(aName: String; aValue: nullable UUID)

 

void writeNullableGuid(String aName, UUID aValue)

Parameters:

  • aName:
  • aValue:

writeNullableInt32

 

method writeNullableInt32(aName: String; aValue: Integer)

 

void writeNullableInt32(String aName, Integer aValue)

Parameters:

  • aName:
  • aValue:

writeNullableInt64

 

method writeNullableInt64(aName: String; aValue: Long)

 

void writeNullableInt64(String aName, Long aValue)

Parameters:

  • aName:
  • aValue:

writeToStream  final    (declared in Message)

For internal use, used by the RO/J framework to stream objects to a message packet.

 

method writeToStream(aStream: ByteArrayOutputStream)

 

void writeToStream(ByteArrayOutputStream aStream)

Parameters:

  • aStream: Given stream.

writeUtf8String

Calls to write UTF8 string.

 

method writeUtf8String(aName: String; aValue: String)

 

void writeUtf8String(String aName, String aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeVariant (String, VariantType)    (declared in Message)

Calls to write VariantType.

 

method writeVariant(aName: String; aValue: VariantType)

 

void writeVariant(String aName, VariantType aValue)

Parameters:

  • aName: Given name.
  • aValue: Given value.

writeVariant (String, VariantType)

 

method writeVariant(name: String; value: VariantType)

 

void writeVariant(String name, VariantType value)

Parameters:

  • name:
  • value:

writeWideString

Calls to write wide string.

 

method writeWideString(aName: String; aValue: String)

 

void writeWideString(String aName, String aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.

writeXml

Calls to write XmlType.

 

method writeXml(aName: String; aValue: XmlType)

 

void writeXml(String aName, XmlType aValue)

Parameters:

  • aName: Ignored. Can be nil.
  • aValue: Given value.