Package org.glassfish.grizzly.spdy

Class Source

java.lang.Object

org.glassfish.grizzly.spdy.Source

public abstract class Source
extends Object

The class represents generic source of data to be sent on SpdyStream.

Author:

Alexey Stashok

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Source.SourceFactory	The helper factory class to create Sources based on File, Buffer, String and byte[].

Constructor Summary

Constructors

Constructor	Description
Source()

Method Summary

Modifier and Type	Method	Description
static Source.SourceFactory	factory(SpdyStream spdyStream)	Returns the Source.SourceFactory associated with the SpdyStream.
abstract boolean	hasRemaining()	Returns true if there is more data to be written, or false otherwise.
abstract org.glassfish.grizzly.Buffer	read(int length)	Returns the number of bytes to be written.
abstract void	release()	The method is called, when the source might be released/closed.
abstract long	remaining()	Returns the number of bytes remaining to be written.

Methods inherited from class java.lang.Object

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

Constructor Details

Source

public Source()

Method Details

remaining

public abstract long remaining()

Returns the number of bytes remaining to be written.

read

public abstract org.glassfish.grizzly.Buffer read(int length)
                                           throws SpdyStreamException

Returns the number of bytes to be written.

Parameters:

length - max number of bytes to return.

Returns:

Buffer, which contains up to length bytes (could return less) to be written. null result is not permitted.

Throws:

SpdyStreamException

hasRemaining

public abstract boolean hasRemaining()

Returns true if there is more data to be written, or false otherwise.

release

public abstract void release()

The method is called, when the source might be released/closed.

factory

public static Source.SourceFactory factory(SpdyStream spdyStream)

Returns the Source.SourceFactory associated with the SpdyStream.