com.sonicsw.stream
Interface StreamStatus

public interface StreamStatus

Provides information about the status of a stream.

Field Summary

static java.lang.String[]	STR_STATUS Maps a stream status code into a String value
static int	STR_STATUS_CREATED Status code indicating that stream has been created.
static int	STR_STATUS_ERROR Status code indicating that current stream has encountered an error.
static int	STR_STATUS_TRANSFER_COMPLETE Status code indicating that current stream has completed the transfer process.
static int	STR_STATUS_TRANSFERRING Status code indicating that stream is currently transferring data.
static int	STR_STATUS_UNKNOWN Status code indicating that current stream state is unknown/undefined.

Method Summary

long	getBytesTransferred() Returns the number of bytes currently transferred by/for the stream.
long	getSegmentsDiscarded() Returns the number of segments discarded by the stream up to the current point in time.
long	getSegmentsTransferred() Returns the number of segments currently transferred by/for the stream.
java.lang.String	getStreamId() Returns the identifier assigned to the stream instance.
int	getStreamStatus() Returns current state of stream.
long	getTransferEnd() Returns the time that the current stream transfer ended.
long	getTransferStart() Returns the time that the current stream transfer started.
long	getTransferTime() Returns the total transfer time (from start to finish).

Field Detail

STR_STATUS_UNKNOWN

static final int STR_STATUS_UNKNOWN

Status code indicating that current stream state is unknown/undefined.

See Also:

Constant Field Values

STR_STATUS_CREATED

static final int STR_STATUS_CREATED

Status code indicating that stream has been created.

See Also:

Constant Field Values

STR_STATUS_TRANSFERRING

static final int STR_STATUS_TRANSFERRING

Status code indicating that stream is currently transferring data.

See Also:

Constant Field Values

STR_STATUS_TRANSFER_COMPLETE

static final int STR_STATUS_TRANSFER_COMPLETE

Status code indicating that current stream has completed the transfer process.

See Also:

Constant Field Values

STR_STATUS_ERROR

static final int STR_STATUS_ERROR

Status code indicating that current stream has encountered an error.

See Also:

Constant Field Values

STR_STATUS

static final java.lang.String[] STR_STATUS

Maps a stream status code into a String value

Method Detail

getBytesTransferred

long getBytesTransferred()

Returns the number of bytes currently transferred by/for the stream.

Returns:

number of bytes currently transferred

getSegmentsTransferred

long getSegmentsTransferred()

Returns the number of segments currently transferred by/for the stream.

Returns:

number of segments currently transferred

getTransferStart

long getTransferStart()

Returns the time that the current stream transfer started.

Returns:

transfer start time

getTransferEnd

long getTransferEnd()

Returns the time that the current stream transfer ended.

Returns:

transfer end time

getTransferTime

long getTransferTime()

Returns the total transfer time (from start to finish).

Returns:

transfer time

getStreamStatus

int getStreamStatus()

Returns current state of stream. The value will be that of one of the constants defined in StreamStatus, including:

• STR_STATUS_UNKNOWN
• STR_STATUS_CREATED
• STR_STATUS_TRANSFERRING
• STR_STATUS_TRANSFER_COMPLETE
• STR_STATUS_ERROR

Returns:

current stream state

getSegmentsDiscarded

long getSegmentsDiscarded()

Returns the number of segments discarded by the stream up to the current point in time. The segment count includes those segments that are duplicates, received after the timeout period has expired, or both.

Returns:

number of discarded segments

getStreamId

java.lang.String getStreamId()

Returns the identifier assigned to the stream instance.

Returns:

stream identifier