IMessage

Overview

IMessage interface for message class.

Location

Implemented in

Required Methods


clear

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

 

method clear

 

void clear()

createExceptionWithClassName

Creates exception object.

 

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

 

ExceptionType createExceptionWithClassName(String aExceptionName, String aMessage)

Parameters:

  • aExceptionName: Given name.
  • aMessage: Given message.

doReadException

Calls to read exception params from stream.

 

method doReadException(aException: ExceptionType)

 

void doReadException(ExceptionType aException)

Parameters:

  • aException: Given exception.

doReadObject

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

Calls to write ComplexType elements.

 

method doWriteObject(aName: String; aValue: IStreamable)

 

void doWriteObject(String aName, IStreamable aValue)

Parameters:

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

getStream

This method provide envelopes processing.

 

method getStream: ByteArrayOutputStream

 

ByteArrayOutputStream getStream()

initializeAsRequestMessage

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

Raises exception from server.

 

method processException

 

void processException()

readComplex

Calls to read struct.

 

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

 

ComplexType readComplex(String aName, Class aValue)

Parameters:

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

readException

Calls to read and raise exception.

 

method readException: ExceptionType

 

ExceptionType readException()

readFromStream

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.

writeComplex

Calls to write struct.

 

method writeComplex(aName: String; aValue: ComplexType)

 

void writeComplex(String aName, ComplexType aValue)

Parameters:

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

writeToStream

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.

See Also

  • IMessage Interface