org.resilientedge.jockey.peer
Class ReceiveMarker

java.lang.Object
  |
  +--org.resilientedge.jockey.peer.ReceiveMarker

public class ReceiveMarker

extends java.lang.Object

Represents a message that is currently being received but not completed.

Version:

$Revision: 1.1.1.1 $

Author:

John Gardner

Field Summary

static int	RECEIVED This status indicates that a response message has been received and is ready to be processed.
static int	RECEIVING This status indicates that a message has been started but is not yet complete.

Constructor Summary

ReceiveMarker()

Method Summary

void	cancel() Cancels the current message that is being received.
int	getCurrentSize() Returns number of bytes of message received so far.
int	getStatus() Returns the status of the message reception.
int	getTotalSize() Returns number of bytes of message received so far.
boolean	isComplete() Returns true if the message receipt is complete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RECEIVING

public static final int RECEIVING

This status indicates that a message has been started but is not yet complete.

RECEIVED

public static final int RECEIVED

This status indicates that a response message has been received and is ready to be processed.

Constructor Detail

ReceiveMarker

public ReceiveMarker()

Method Detail

getStatus

public int getStatus()

Returns the status of the message reception.

Returns:

The Status value

isComplete

public boolean isComplete()

Returns true if the message receipt is complete.

Returns:

The Complete value

getCurrentSize

public int getCurrentSize()

Returns number of bytes of message received so far.

Returns:

The CurrentSize value

getTotalSize

public int getTotalSize()

Returns number of bytes of message received so far.

Returns:

The TotalSize value

cancel

public void cancel()

Cancels the current message that is being received. This may be used if the message is too large or a duplicate.