nxm.ice.net

Class Rmif.Packet

java.lang.Object

nxm.ice.net.Rmif.Packet

Enclosing class:

Rmif

public class Rmif.Packet
extends java.lang.Object

Packet to serve to clients (for sending or receiving).

Constructor Summary

Constructors

Constructor and Description
Packet(byte[] buf, int off, int len) Creates a new Packet object with the time set to zero.
Packet(byte[] buf, int off, int len, boolean copy) Creates a new Packet object with the time set to zero.

Method Summary

Modifier and Type	Method and Description
byte	getAdj() RMIF Packet Field: adj (size of adjunct header)
java.lang.String	getData() Gets the packet data as a String.
byte	getFlag() RMIF Packet Field: info
byte	getFunc() RMIF Packet Field: func (see getFunction()).
java.lang.String	getFunction() The name of the RMIF function (see getFunc()).
byte	getInfo() RMIF Packet Field: info
java.lang.String	getProtocol() The name of the protocol used (see getSeq()).
byte	getRep() RMIF Packet Field: rep (data representation: IEEE, EEEI, etc).
byte	getRpt() RMIF Packet Field: ptr (not used, always 0)
byte	getSeq() RMIF Packet Field: seq (>=0: RDP sequence number, <0 Protocol ID).
byte	getTry() RMIF Packet Field: try (RDP packet try number, see getProtocol())
java.lang.String	toString() Gets a description of the RMIF packet useful for debugging.
java.lang.String	toStringShort() Short form of toString that only prints out 12 characters in data and time using just HMS.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Packet

public Packet(byte[] buf,
              int off,
              int len)

Creates a new Packet object with the time set to zero. This makes a **COPY** of the buffer.

Parameters:

buf - The packet buffer.

off - The offset into the buffer for the start of the packet.

len - The total length of the RMIF packet in bytes (RMIF header + Data).

Packet

public Packet(byte[] buf,
              int off,
              int len,
              boolean copy)

Creates a new Packet object with the time set to zero.

Parameters:

buf - The packet buffer.

off - The offset into the buffer for the start of the packet.

len - The total length of the RMIF packet in bytes (RMIF header + Data).

copy - Should a copy of the buffer be made? deprecate this constructor?

Method Detail

getFunc

public byte getFunc()

RMIF Packet Field: func (see getFunction()).

Returns:

comment here

getFlag

public byte getFlag()

RMIF Packet Field: info

Returns:

comment here

getInfo

public byte getInfo()

RMIF Packet Field: info

Returns:

comment here

getRep

public byte getRep()

RMIF Packet Field: rep (data representation: IEEE, EEEI, etc).

Returns:

comment here

getSeq

public byte getSeq()

RMIF Packet Field: seq (>=0: RDP sequence number, <0 Protocol ID).

Returns:

comment here

getTry

public byte getTry()

RMIF Packet Field: try (RDP packet try number, see getProtocol())

Returns:

comment here

getRpt

public byte getRpt()

RMIF Packet Field: ptr (not used, always 0)

Returns:

comment here

getAdj

public byte getAdj()

RMIF Packet Field: adj (size of adjunct header)

Returns:

comment here

getFunction

public java.lang.String getFunction()

The name of the RMIF function (see getFunc()).

Returns:

comment here

getProtocol

public java.lang.String getProtocol()

The name of the protocol used (see getSeq()).

Returns:

comment here

getData

public java.lang.String getData()

Gets the packet data as a String.

Returns:

comment here

toString

public java.lang.String toString()

Gets a description of the RMIF packet useful for debugging. This just includes the header information of the RMIF packet.

Overrides:

toString in class java.lang.Object

toStringShort

public java.lang.String toStringShort()

Short form of toString that only prints out 12 characters in data and time using just HMS. This is only used for testing

Returns:

comment here