Message (GlassFish Corba ORB 4.2.1 API)

All Known Subinterfaces:

CancelRequestMessage, FragmentMessage, LocateReplyMessage, LocateReplyOrReplyMessage, LocateRequestMessage, ReplyMessage, RequestMessage

All Known Implementing Classes:

CancelRequestMessage_1_0, CancelRequestMessage_1_1, CancelRequestMessage_1_2, FragmentMessage_1_1, FragmentMessage_1_2, LocateReplyMessage_1_0, LocateReplyMessage_1_1, LocateReplyMessage_1_2, LocateRequestMessage_1_0, LocateRequestMessage_1_1, LocateRequestMessage_1_2, Message_1_0, Message_1_1, Message_1_2, MessageBase, ReplyMessage_1_0, ReplyMessage_1_1, ReplyMessage_1_2, RequestMessage_1_0, RequestMessage_1_1, RequestMessage_1_2
```
public interface Message
```
This is the base interface for different message type interfaces.

Version:

1.0

Author:

Ram Jeyaraman 05/14/2000

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`defaultBufferSize`
`static byte`	`FLAG_NO_FRAG_BIG_ENDIAN`
`static int`	`GIOPBigMagic`
`static byte`	`GIOPCancelRequest`
`static byte`	`GIOPCloseConnection`
`static byte`	`GIOPFragment`
`static byte`	`GIOPLocateReply`
`static byte`	`GIOPLocateRequest`
`static byte`	`GIOPMessageError`
`static int`	`GIOPMessageHeaderLength`
`static byte`	`GIOPReply`
`static byte`	`GIOPRequest`
`static byte`	`LITTLE_ENDIAN_BIT`
`static byte`	`MORE_FRAGMENTS_BIT`
`static byte`	`THREAD_POOL_TO_USE_MASK`
`static byte`	`TRAILING_TWO_BIT_BYTE_MASK`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`callback(MessageHandler handler)`
`FragmentMessage`	`createFragmentMessage()`
`RequestId`	`getCorbaRequestId()` Return a Message's CorbaRequestId.
`byte`	`getEncodingVersion()`
`GIOPVersion`	`getGIOPVersion()`
`int`	`getSize()`
`int`	`getThreadPoolToUse()`
`int`	`getType()`
`boolean`	`isLittleEndian()`
`boolean`	`moreFragmentsToFollow()`
`void`	`read(InputStream istream)`
`void`	`setEncodingVersion(byte version)`
`void`	`setSize(ByteBuffer byteBuffer, int size)`
`boolean`	`supportsFragments()` Returns whether the Message supports message fragmenting.
`void`	`write(OutputStream ostream)`

- Field Detail
  - defaultBufferSize
```
static final int defaultBufferSize
```
    See Also:
    
    Constant Field Values
  - GIOPBigMagic
```
static final int GIOPBigMagic
```
    See Also:
    
    Constant Field Values
  - GIOPMessageHeaderLength
```
static final int GIOPMessageHeaderLength
```
    See Also:
    
    Constant Field Values
  - LITTLE_ENDIAN_BIT
```
static final byte LITTLE_ENDIAN_BIT
```
    See Also:
    
    Constant Field Values
  - MORE_FRAGMENTS_BIT
```
static final byte MORE_FRAGMENTS_BIT
```
    See Also:
    
    Constant Field Values
  - FLAG_NO_FRAG_BIG_ENDIAN
```
static final byte FLAG_NO_FRAG_BIG_ENDIAN
```
    See Also:
    
    Constant Field Values
  - TRAILING_TWO_BIT_BYTE_MASK
```
static final byte TRAILING_TWO_BIT_BYTE_MASK
```
    See Also:
    
    Constant Field Values
  - THREAD_POOL_TO_USE_MASK
```
static final byte THREAD_POOL_TO_USE_MASK
```
    See Also:
    
    Constant Field Values
  - GIOPRequest
```
static final byte GIOPRequest
```
    See Also:
    
    Constant Field Values
  - GIOPReply
```
static final byte GIOPReply
```
    See Also:
    
    Constant Field Values
  - GIOPCancelRequest
```
static final byte GIOPCancelRequest
```
    See Also:
    
    Constant Field Values
  - GIOPLocateRequest
```
static final byte GIOPLocateRequest
```
    See Also:
    
    Constant Field Values
  - GIOPLocateReply
```
static final byte GIOPLocateReply
```
    See Also:
    
    Constant Field Values
  - GIOPCloseConnection
```
static final byte GIOPCloseConnection
```
    See Also:
    
    Constant Field Values
  - GIOPMessageError
```
static final byte GIOPMessageError
```
    See Also:
    
    Constant Field Values
  - GIOPFragment
```
static final byte GIOPFragment
```
    See Also:
    
    Constant Field Values
- Method Detail
  - supportsFragments
```
boolean supportsFragments()
```
    Returns whether the Message supports message fragmenting.
    
    Returns:
    
    true if Message supports fragmenting or is a message fragment. Otherwise false it does not support message fragments.
  - getGIOPVersion
```
GIOPVersion getGIOPVersion()
```
  - getEncodingVersion
```
byte getEncodingVersion()
```
  - isLittleEndian
```
boolean isLittleEndian()
```
  - moreFragmentsToFollow
```
boolean moreFragmentsToFollow()
```
  - getType
```
int getType()
```
  - getSize
```
int getSize()
```
  - getThreadPoolToUse
```
int getThreadPoolToUse()
```
  - read
```
void read(InputStream istream)
```
  - write
```
void write(OutputStream ostream)
```
  - setSize
```
void setSize(ByteBuffer byteBuffer,
             int size)
```
  - createFragmentMessage
```
FragmentMessage createFragmentMessage()
```
  - callback
```
void callback(MessageHandler handler)
       throws IOException
```
    Throws:
    
    IOException
  - setEncodingVersion
```
void setEncodingVersion(byte version)
```
  - getCorbaRequestId
```
RequestId getCorbaRequestId()
```
    Return a Message's CorbaRequestId. Messages which do not support a request id in the 4 bytes following the 12 byte GIOP message header shall return an undefined CorbaRequestId.

Interface Message

Field Summary

Method Summary

Field Detail

defaultBufferSize

GIOPBigMagic

GIOPMessageHeaderLength

LITTLE_ENDIAN_BIT

MORE_FRAGMENTS_BIT

FLAG_NO_FRAG_BIG_ENDIAN

TRAILING_TWO_BIT_BYTE_MASK

THREAD_POOL_TO_USE_MASK

GIOPRequest

GIOPReply

GIOPCancelRequest

GIOPLocateRequest

GIOPLocateReply

GIOPCloseConnection

GIOPMessageError

GIOPFragment

Method Detail

supportsFragments

getGIOPVersion

getEncodingVersion

isLittleEndian

moreFragmentsToFollow

getType

getSize

getThreadPoolToUse

read

write

setSize

createFragmentMessage

callback

setEncodingVersion

getCorbaRequestId