org.eclipse.jetty.io

Class FillInterest

java.lang.Object

org.eclipse.jetty.io.FillInterest

public abstract class FillInterest
extends Object

A Utility class to help implement EndPoint.fillInterested(Callback) by keeping state and calling the context and callback objects.

Method Summary

Modifier and Type	Method and Description
boolean	fillable() Call to signal that a read is now possible.
Invocable.InvocationType	getCallbackInvocationType()
boolean	isInterested()
void	onClose()
boolean	onFail(Throwable cause) Call to signal a failure to a registered interest
void	register(Callback callback) Call to register interest in a callback when a read is possible.
String	toStateString()
String	toString()
boolean	tryRegister(Callback callback) Call to register interest in a callback when a read is possible.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

register

public void register(Callback callback)
              throws ReadPendingException

Call to register interest in a callback when a read is possible. The callback will be called either immediately if needsFillInterest() returns true or eventually once fillable() is called.

Parameters:

callback - the callback to register

Throws:

ReadPendingException - if unable to read due to pending read op

tryRegister

public boolean tryRegister(Callback callback)

Call to register interest in a callback when a read is possible. The callback will be called either immediately if needsFillInterest() returns true or eventually once fillable() is called.

Parameters:

callback - the callback to register

Returns:

true if the register succeeded

fillable

public boolean fillable()

Call to signal that a read is now possible.

isInterested

public boolean isInterested()

Returns:

True if a read callback has been registered

getCallbackInvocationType

public Invocable.InvocationType getCallbackInvocationType()

onFail

public boolean onFail(Throwable cause)

Call to signal a failure to a registered interest

Parameters:

cause - the cause of the failure

Returns:

true if the cause was passed to a Callback instance

onClose

public void onClose()

toString

public String toString()

Overrides:

toString in class Object

toStateString

public String toStateString()