com.enderak.procol.common.net
Class ProColMessage

java.lang.Object
  |
  +--com.enderak.procol.common.net.ProColMessage
Direct Known Subclasses:
ProColIncomingMessage, ProColOutgoingMessage

public class ProColMessage
extends java.lang.Object

Provides a central class for some some standard operations on SSL sockets

Author:
Justin Dieters

Field Summary
 int messageID
          The message ID for this message
 int requestCode
          The request code for this message
 
Constructor Summary
ProColMessage(int messageIDIn, int requestCodeIn)
          Create a new message with an initial messageID and requestCode
ProColMessage(ProColPacket packetIn)
          Create a new Message with an initial packet
 
Method Summary
 boolean isError()
          determine if this message is an error message, (if requestCode is of the form 0xF*******)
 java.lang.String toString()
          Get the String representation of this message4
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

messageID

public int messageID
The message ID for this message


requestCode

public int requestCode
The request code for this message

Constructor Detail

ProColMessage

public ProColMessage(ProColPacket packetIn)
Create a new Message with an initial packet

Parameters:
packetIn - The packet

ProColMessage

public ProColMessage(int messageIDIn,
                     int requestCodeIn)
Create a new message with an initial messageID and requestCode

Parameters:
messageIDIn - The message ID
requestCodeIn - The request code
Method Detail

isError

public boolean isError()
determine if this message is an error message, (if requestCode is of the form 0xF*******)

Returns:
true if this is an error message

toString

public java.lang.String toString()
Get the String representation of this message4

Overrides:
toString in class java.lang.Object
Returns:
This message in string form