Package com.yahoo.jdisc.handler

Class BufferedContentChannel

java.lang.Object

com.yahoo.jdisc.handler.BufferedContentChannel

All Implemented Interfaces:

ContentChannel

public final class BufferedContentChannel
extends Object
implements ContentChannel

This class implements an unlimited, non-blocking content queue. All ContentChannel methods are implemented by pushing to a thread-safe internal queue. All of the queued calls are forwarded to another ContentChannel when connectTo(ContentChannel) is called. Once connected, this class becomes a non-buffering proxy for the connected ContentChannel.

Author:

Simon Thoresen Hult

Constructor Summary

Constructors

Constructor	Description
BufferedContentChannel()

Method Summary

Modifier and Type	Method	Description
void	close(CompletionHandler handler)	Closes this ContentChannel.
void	connectTo(ContentChannel content)	Connects this BufferedContentChannel to a ContentChannel.
boolean	isConnected()	Returns whether or not connectTo(ContentChannel) has been called.
ReadableContentChannel	toReadable()	Creates a ReadableContentChannel and connects to it.
ContentInputStream	toStream()	Creates a ContentInputStream and connects to its internal ContentChannel.
void	write(ByteBuffer buf, CompletionHandler handler)	Schedules the given ByteBuffer to be written to the content corresponding to this ContentChannel.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.jdisc.handler.ContentChannel

onError

Constructor Detail

BufferedContentChannel

public BufferedContentChannel()

Method Detail

connectTo

public void connectTo(ContentChannel content)

Connects this BufferedContentChannel to a ContentChannel. First, this method forwards all queued calls to the connected ContentChannel. Once this method has been called, all future calls to write(ByteBuffer, CompletionHandler) and close(CompletionHandler) are synchronously forwarded to the connected ContentChannel.

Parameters:

content - The ContentChannel to connect to.

Throws:

NullPointerException - If the content argument is null.

IllegalStateException - If another ContentChannel has already been connected.

isConnected

public boolean isConnected()

Returns whether or not connectTo(ContentChannel) has been called. Even if this method returns false, calling connectTo(ContentChannel) might still throw an IllegalStateException if there is a race.

Returns:

True if connectTo(ContentChannel) has been called.

toReadable

public ReadableContentChannel toReadable()

Creates a ReadableContentChannel and connects to it.

Returns:

The new ReadableContentChannel that this connected to.

toStream

public ContentInputStream toStream()

Creates a ContentInputStream and connects to its internal ContentChannel.

Returns:

The new ContentInputStream that this connected to.

write

public void write(ByteBuffer buf,
                  CompletionHandler handler)

Description copied from interface: ContentChannel

Schedules the given ByteBuffer to be written to the content corresponding to this ContentChannel. This call transfers ownership of the given ByteBuffer to this ContentChannel, i.e. no further calls can be made to the buffer. The execution of writes happen in the same order as this method was invoked.

Specified by:

write in interface ContentChannel

Parameters:

buf - The ByteBuffer to schedule for write. No further calls can be made to this buffer.

handler - The CompletionHandler to call after the write has been executed.

close

public void close(CompletionHandler handler)

Description copied from interface: ContentChannel

Closes this ContentChannel. After a channel is closed, any further attempt to invoke ContentChannel.write(ByteBuffer, CompletionHandler) upon it will cause an IllegalStateException to be thrown. If this channel is already closed then invoking this method has no effect, but CompletionHandler.completed() will still be called. Notice that you MUST call this method, regardless of any exceptions that might have occurred while writing to this ContentChannel. Failure to do so will prevent the Container from ever shutting down.

Specified by:

close in interface ContentChannel

Parameters:

handler - The CompletionHandler to call after the close has been executed.