All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface javax.media.protocol.PushSourceStream

public interface PushSourceStream
extends SourceStream
Abstracts a read interface that pushes data.

Version:
1.7, 97/08/25.
See Also:
PushDataSource

Method Index

 o getMinimumTransferSize()
Determine the size of the buffer needed for the data transfer.
 o read(byte[], int, int)
Read from the stream without blocking.
 o setTransferHandler(SourceTransferHandler)
Register an object to service data transfers to this stream.

Methods

 o read
 public abstract int read(byte buffer[],
                          int offset,
                          int length)
Read from the stream without blocking. Returns -1 when the end of the media is reached.

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.
 o getMinimumTransferSize
 public abstract int getMinimumTransferSize()
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.

Returns:
The size of the data transfer.
 o setTransferHandler
 public abstract void setTransferHandler(SourceTransferHandler transferHandler)
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.

Parameters:
transferHandler - The handler to transfer data to.

All Packages  Class Hierarchy  This Package  Previous  Next  Index