org.eclipse.jetty.util

Class SharedBlockingCallback.Blocker

java.lang.Object

org.eclipse.jetty.util.SharedBlockingCallback.Blocker

All Implemented Interfaces:

Closeable, AutoCloseable, Callback, Invocable

Enclosing class:

SharedBlockingCallback

public class SharedBlockingCallback.Blocker
extends Object
implements Callback, Closeable

A Closeable Callback. Uses the auto close mechanism to check block has been called OK.

Implements Callback because calls to this callback do not blocak, rather they wakeup the thread that is blocked in block()

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Callback

Callback.Completable, Callback.Nested

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

Invocable.InvocationType

Field Summary

Fields inherited from interface org.eclipse.jetty.util.Callback

NOOP

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Blocker()

Method Summary

Modifier and Type	Method and Description
void	block() Block until the Callback has succeeded or failed and after the return leave in the state to allow reuse.
void	close() Check the Callback has succeeded or failed and after the return leave in the state to allow reuse.
void	failed(Throwable cause) Callback invoked when the operation fails.
Invocable.InvocationType	getInvocationType()
void	succeeded() Callback invoked when the operation completes.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.Callback

from, from

Methods inherited from interface org.eclipse.jetty.util.thread.Invocable

getInvocationType, invokeNonBlocking, isNonBlockingInvocation

Constructor Detail

Blocker

protected Blocker()

Method Detail

getInvocationType

public Invocable.InvocationType getInvocationType()

Specified by:

getInvocationType in interface Invocable

Returns:

The InvocationType of this object

succeeded

public void succeeded()

Description copied from interface: Callback

Callback invoked when the operation completes.

Specified by:

succeeded in interface Callback

See Also:

Callback.failed(Throwable)

failed

public void failed(Throwable cause)

Description copied from interface: Callback

Callback invoked when the operation fails.

Specified by:

failed in interface Callback

Parameters:

cause - the reason for the operation failure

block

public void block()
           throws IOException

Block until the Callback has succeeded or failed and after the return leave in the state to allow reuse. This is useful for code that wants to repeatable use a FutureCallback to convert an asynchronous API to a blocking API.

Throws:

IOException - if exception was caught during blocking, or callback was cancelled

close

public void close()

Check the Callback has succeeded or failed and after the return leave in the state to allow reuse.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object