CADI.Common.Network.JPIP
Class JPIPMessage

java.lang.Object
  extended by CADI.Common.Network.JPIP.JPIPMessage

public class JPIPMessage
extends java.lang.Object

The class JPIPMessage is useful to store JPIP messages. It contains: the JPIP header that provides descriptive information to identify the JPIP message in the data-bin, and the message body which is a segment from a data-bin.

Version:
1.0 2007/10/26
Author:
Group on Interactive Coding of Images (GICI)

Field Summary
 JPIPMessageHeader header
          Contains the JPIP message header.
 long headerLength
          Indicates the length of the JPIP message header.
 byte[] messageBody
          Is the body of the JPIP message, i.e., it is data from a data-bin.
 
Constructor Summary
JPIPMessage()
          Default constructor.
 
Method Summary
 void list(java.io.PrintStream out)
          Prints this JPIPMessage out to the specified output stream.
 void reset()
          Sets the attributes to its initial vaules.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

header

public JPIPMessageHeader header
Contains the JPIP message header. JPIPMessageHeader


messageBody

public byte[] messageBody
Is the body of the JPIP message, i.e., it is data from a data-bin.


headerLength

public long headerLength
Indicates the length of the JPIP message header. This attribute is useful for statistics.

Constructor Detail

JPIPMessage

public JPIPMessage()
Default constructor.

Method Detail

reset

public void reset()
Sets the attributes to its initial vaules.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

list

public void list(java.io.PrintStream out)
Prints this JPIPMessage out to the specified output stream. This method is useful for debugging.

Parameters:
out - an output stream.


CADI - Copyright (C) 2007
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Group on Interactive Coding of Images (GICI) (contact)