com.sun.tv.net

Class EncapIPStream

java.lang.Object

com.sun.tv.net.EncapIPStream

All Implemented Interfaces:

Controls, PushSourceStream, SourceStream, PushSourceStream2

public class EncapIPStream
extends Object
implements PushSourceStream2

The interface PushSourceStream2 identifies a SourceStream that pushes asynchronous data.

Note that a PushSourceStream2 provides no guarantees of the length of time that incoming data will be buffered before being discarded or overwritten with new data. Because of the time-dependent nature of the stream, clients should read the pending data immediately upon notification.

Field Summary

Fields inherited from interface javax.media.protocol.SourceStream

LENGTH_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
EncapIPStream(Locator loc)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	endOfStream() Find out if the end of the stream has been reached.
ContentDescriptor	getContentDescriptor() Get the current content type for this stream.
long	getContentLength() Get the size, in bytes, of the content on this stream.
Object	getControl(String controlType) Obtain the object that implements the specified Class or Interface The full class or interface name must be used.
Object[]	getControls() Obtain the collection of objects that control the object that implements this interface.
int	getMinimumTransferSize() Determine the size of the buffer needed for the data transfer.
boolean	getOpen()
static boolean	isIPStreamLocator(Locator loc)
int	read(byte[] buffer, int offset, int length) Read from the stream without blocking.
int	readStream(byte[] buffer, int offset, int length) Reads pending data from the stream without blocking.
void	setOpen(boolean open) this is for the DataSource or whoever constructs this stream to open the stream.
void	setTransfer(boolean transfer) This is a method for the DataSource corresponding to the stream to control the start/stop of the data transfer.
void	setTransferHandler(SourceTransferHandler transferHandler) Register an object to service data transfers to this stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncapIPStream

public EncapIPStream(Locator loc)
              throws InvalidLocatorException

Throws:

InvalidLocatorException

Method Detail

isIPStreamLocator

public static boolean isIPStreamLocator(Locator loc)

read

public int read(byte[] buffer,
       int offset,
       int length)

Description copied from interface: PushSourceStream

Read from the stream without blocking. Returns -1 when the end of the media is reached.

Specified by:

read in interface PushSourceStream

Parameters:

buffer - The buffer to read bytes into.

offset - The offset into the buffer at which to begin writing data.

length - The number of bytes to read.

Returns:

The number of bytes read or -1 when the end of stream is reached.

readStream

public int readStream(byte[] buffer,
             int offset,
             int length)
               throws IOException,
                      DataLostException

Reads pending data from the stream without blocking.

Specified by:

readStream in interface PushSourceStream2

Parameters:

buffer - The buffer to read bytes into.

offset - The offset into the buffer at which to begin writing data.

length - The number of bytes to read.

Returns:

The number of bytes read or -1 when the end of stream is reached.

Throws:

IOException - If an I/O error occurs.

DataLostException - If data from the stream has been lost.

setTransferHandler

public void setTransferHandler(SourceTransferHandler transferHandler)

Description copied from interface: PushSourceStream

Register an object to service data transfers to this stream.

If a handler is already registered when setTransferHandler is called, the handler is replaced; there can only be one handler at a time.

Specified by:

setTransferHandler in interface PushSourceStream

Parameters:

transferHandler - The handler to transfer data to.

getMinimumTransferSize

public int getMinimumTransferSize()

Description copied from interface: PushSourceStream

Determine the size of the buffer needed for the data transfer. This method is provided so that a transfer handler can determine how much data, at a minimum, will be available to transfer from the source. Overflow and data loss is likely to occur if this much data isn't read at transfer time.

Specified by:

getMinimumTransferSize in interface PushSourceStream

Returns:

The size of the data transfer.

endOfStream

public boolean endOfStream()

Find out if the end of the stream has been reached.

Specified by:

endOfStream in interface SourceStream

Returns:

Returns true if there is no more data.

getContentDescriptor

public ContentDescriptor getContentDescriptor()

Get the current content type for this stream.

Specified by:

getContentDescriptor in interface SourceStream

Returns:

The current ContentDescriptor for this stream.

getContentLength

public long getContentLength()

Get the size, in bytes, of the content on this stream.

Specified by:

getContentLength in interface SourceStream

Returns:

The content length in bytes.

getControls

public Object[] getControls()

Obtain the collection of objects that control the object that implements this interface. If no controls are supported, a zero length array is returned.

Specified by:

getControls in interface Controls

Returns:

the collection of object controls

getControl

public Object getControl(String controlType)

Obtain the object that implements the specified Class or Interface The full class or interface name must be used. If the control is not supported then null is returned.

Specified by:

getControl in interface Controls

Returns:

the object that implements the control, or null.

setTransfer

public void setTransfer(boolean transfer)

This is a method for the DataSource corresponding to the stream to control the start/stop of the data transfer.

Parameters:

transfer - -- true to start, false to stop

setOpen

public void setOpen(boolean open)

this is for the DataSource or whoever constructs this stream to open the stream.

getOpen

public boolean getOpen()