IMessage Interface (Java)

From RemObjects Wiki
Jump to: navigation, search

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

NamespacesInterfacesClassesEnumsImplements

Contents

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.


Oxygene:   method clear()

Java:   void clear()


createExceptionWithClassName

Creates exception object.


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

Java:   ExceptionType createExceptionWithClassName(String aExceptionName, String aMessage)


Parameters:

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


doReadException

Calls to read exception params from stream.


Oxygene:   method doReadException(aException: ExceptionType)

Java:   void doReadException(ExceptionType aException)


Parameters:

  • aException: Given exception.


doReadObject

Calls to read ComplexType elements.


Oxygene:   method doReadObject(aName: String; aValue: IStreamable)

Java:   void doReadObject(String aName, IStreamable aValue)


Parameters:

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


doWriteObject

Calls to write ComplexType elements.


Oxygene:   method doWriteObject(aName: String; aValue: IStreamable)

Java:   void doWriteObject(String aName, IStreamable aValue)


Parameters:

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


getStream

This method provide envelopes processing.


Oxygene:   method getStream(): ByteArrayOutputStream

Java:   ByteArrayOutputStream getStream()


initializeAsRequestMessage

Initializes request message.


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

Java:   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.


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

Java:   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.


Oxygene:   method processException()

Java:   void processException()


readComplex

Calls to read struct.


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

Java:   ComplexType readComplex(String aName, Class aValue)


Parameters:

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


readException

Calls to read and raise exception.


Oxygene:   method readException(): ExceptionType

Java:   ExceptionType readException()


readFromStream

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


Oxygene:   method readFromStream(aStream: ByteArrayInputStream)

Java:   void readFromStream(ByteArrayInputStream aStream)


Parameters:

  • aStream: Given stream.


writeComplex

Calls to write struct.


Oxygene:   method writeComplex(aName: String; aValue: ComplexType)

Java:   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.


Oxygene:   method writeToStream(aStream: ByteArrayOutputStream)

Java:   void writeToStream(ByteArrayOutputStream aStream)


Parameters:

  • aStream: Given stream.


See Also


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

GlossaryArticlesLibrarySamples

Personal tools
Namespaces

Variants
Actions
Navigation
products
platforms
special
Toolbox