Package org.apache.thrift.server

Class AbstractNonblockingServer.FrameBuffer

java.lang.Object

org.apache.thrift.server.AbstractNonblockingServer.FrameBuffer

Direct Known Subclasses:

AbstractNonblockingServer.AsyncFrameBuffer

Enclosing class:

AbstractNonblockingServer

public class AbstractNonblockingServer.FrameBuffer
extends Object

Class that implements a sort of state machine around the interaction with a client and an invoker. It manages reading the frame size and frame data, getting it handed off as wrapped transports, and then the writing of response data back to the client. In the process it manages flipping the read and write bits on the selection key for its client.

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteBuffer	buffer_
protected final ServerContext	context_
protected final TMemoryInputTransport	frameTrans_
protected final TProtocol	inProt_
protected final TTransport	inTrans_
protected final TProtocol	outProt_
protected final TTransport	outTrans_
protected final TByteArrayOutputStream	response_
protected final SelectionKey	selectionKey_
protected final AbstractNonblockingServer.AbstractSelectThread	selectThread_
protected org.apache.thrift.server.AbstractNonblockingServer.FrameBufferState	state_
protected final TNonblockingTransport	trans_

Constructor Summary

Constructors

Constructor	Description
FrameBuffer(TNonblockingTransport trans, SelectionKey selectionKey, AbstractNonblockingServer.AbstractSelectThread selectThread)

Method Summary

Modifier and Type	Method	Description
void	changeSelectInterests()	Give this FrameBuffer a chance to set its interest to write, once data has come in.
void	close()	Shut the connection down.
void	invoke()	Actually invoke the method signified by this FrameBuffer.
boolean	isFrameFullyRead()	Check if this FrameBuffer has a full frame read.
boolean	read()	Give this FrameBuffer a chance to read.
protected void	requestSelectInterestChange()	When this FrameBuffer needs to change its select interests and execution might not be in its select thread, then this method will make sure the interest change gets done when the select thread wakes back up.
void	responseReady()	After the processor has processed the invocation, whatever thread is managing invocations should call this method on this FrameBuffer so we know it's time to start trying to write again.
boolean	write()	Give this FrameBuffer a chance to write its output to the final client.

Methods inherited from class java.lang.Object

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

Field Details

trans_

protected final TNonblockingTransport trans_

selectionKey_

protected final SelectionKey selectionKey_

selectThread_

protected final AbstractNonblockingServer.AbstractSelectThread selectThread_

state_

protected org.apache.thrift.server.AbstractNonblockingServer.FrameBufferState state_

buffer_

protected ByteBuffer buffer_

response_

protected final TByteArrayOutputStream response_

frameTrans_

protected final TMemoryInputTransport frameTrans_

inTrans_

protected final TTransport inTrans_

outTrans_

protected final TTransport outTrans_

inProt_

protected final TProtocol inProt_

outProt_

protected final TProtocol outProt_

context_

protected final ServerContext context_

Constructor Details

FrameBuffer

public FrameBuffer(TNonblockingTransport trans,
 SelectionKey selectionKey,
 AbstractNonblockingServer.AbstractSelectThread selectThread)
            throws TTransportException

Throws:

TTransportException

Method Details

read

public boolean read()

Give this FrameBuffer a chance to read. The selector loop should have received a read event for this FrameBuffer.

Returns:

true if the connection should live on, false if it should be closed

write

public boolean write()

Give this FrameBuffer a chance to write its output to the final client.

changeSelectInterests

public void changeSelectInterests()

Give this FrameBuffer a chance to set its interest to write, once data has come in.

close

public void close()

Shut the connection down.

isFrameFullyRead

public boolean isFrameFullyRead()

Check if this FrameBuffer has a full frame read.

responseReady

public void responseReady()

After the processor has processed the invocation, whatever thread is managing invocations should call this method on this FrameBuffer so we know it's time to start trying to write again. Also, if it turns out that there actually isn't any data in the response buffer, we'll skip trying to write and instead go back to reading.

invoke

public void invoke()

Actually invoke the method signified by this FrameBuffer.

requestSelectInterestChange

protected void requestSelectInterestChange()

When this FrameBuffer needs to change its select interests and execution might not be in its select thread, then this method will make sure the interest change gets done when the select thread wakes back up. When the current thread is this FrameBuffer's select thread, then it just does the interest change immediately.