progress.message.jclient
Interface ChannelStatus

public interface ChannelStatus

This interface is a user's window into the current status of a channel. The status codes returned is dependent on the type of channel in use.

See Also:

RecoverableFileChannel

Method Summary

long	bytesToTransfer() Returned the number of bytes to transfer.
long	bytesTransferred() Return the number of bytes that have been transferred on this channel.
int	getStatus() Return the current status of the channel.

Method Detail

bytesTransferred

long bytesTransferred()
                      throws JMSException

Return the number of bytes that have been transferred on this channel.

Returns:

The number of bytes transferred, -1 if unknown.

Throws:

JMSException - If there is an internal JMS error.

bytesToTransfer

long bytesToTransfer()
                     throws JMSException

Returned the number of bytes to transfer.

Returns:

The number of bytes to transfer, -1 if unknown.

Throws:

JMSException - if there is an internal JMS error.

getStatus

int getStatus()
              throws JMSException

Return the current status of the channel.

Returns:

The status code.

Throws:

JMSException - If there is an internal JMS error.

See Also:

RecoverableFileChannel