Class MessageHeader

public static final byte CANCEL_REQUEST

Cancel request message.

Field Value:

2

public static final byte CLOSE_CONNECTION

Instruction to close the connection.

Field Value:

5

public static final byte FRAGMENT

The fragment messge, following the previous message that has more fragments flag set. Added in GIOP 1.1

Field Value:

7

public static final byte LOCATE_REPLY

Locate reply message, sent in response to the MessageHeader message.

Field Value:

4

public static final byte LOCATE_REQUEST

Locate request message, used to check the server ability to process requests for the object reference. This message is also used to get the address where the object reference should be sent.

Field Value:

3

public static final byte[] MAGIC

This must always be "GIOP".

public static final byte MESSAGE_ERROR

Error report.

Field Value:

6

public static final byte REPLY

Reply message

Field Value:

1

public static final byte REQUEST

Request message.

Field Value:

0

public byte flags

The flags field, introduced since GIOP 1.1.

public int message_size

The message size, excluding the message header.

public byte message_type

The message type.

protected static String[] types

The message type names.

public Version version

The GIOP version. Initialised to 1.0 .

public MessageHeader()

Create an empty message header, corresponding version 1.0.

public MessageHeader(int major,
                     int minor)

Create an empty message header, corresponding the given version.

Parameters:

major - the major message header version.

minor - the minot message header version.

public CancelHeader create_cancel_header()

Create the cancel header, matching the message header version number.

public ErrorMessage create_error_message()

Create the error message.

public ReplyHeader create_reply_header()

Creates reply header, matching the message header version number.

Returns:

one of ReplyHeader, ReplyHeader, etc - depending on the version number in this header.

public RequestHeader create_request_header()

Creates request header, matching the message header version number.

Returns:

one of RequestHeader, RequestHeader, etc - depending on the version number in this header.

public int getHeaderSize()

Get the size of the message header itself. So far, it is always 12 bytes.

public String getTypeString(int type)

Get the message type as string.

Parameters:

type - the message type as int (the field message_type).

Returns:

the message type as string.

public boolean isBigEndian()

Checks if the message is encoded in the Big Endian, most significant byte first.

public boolean moreFragmentsFollow()

Checks if the message is partial, and more subsequent fragments follow.

public void read(InputStream istream)
            throws MARSHAL,
                   EOFException

Read the header from the stream.

Parameters:

istream - a stream to read from.

Throws:

MARSHAL - if this is not a GIOP 1.0 header.

public byte[] readMessage(InputStream source,
                          Socket service,
                          int to_read,
                          int to_pause)

Read data, followed by the message header. Handle fragmented messages.

Parameters:

source - the data source to read from.

service - the socket on that the time outs are set. Can be null (no timeouts are set).

to_read - the timeout while reading the message.

to_pause - the timeout for pauses between the message parts.

public void setBigEndian(boolean use_big_endian)

Set the encoding to use.

Parameters:

use_big_endian - if true (default), the Big Endian encoding is used. If false, the Little Endian encoding is used.

public String toString()

Get the short string summary of the message.

Overrides:

toString in interface Object

Returns:

a short message summary.

public void write(OutputStream out)

Write the header to stream.

Parameters:

out - a stream to write into.