Modifier and Type	Class and Description
public static class	Callback.Completable A `Callback` that is also a `CompletableFuture`.

Modifier and Type	Field and Description
public static final Callback	NOOP Empty implementation.

Modifier and Type	Method and Description
public default BiConsumer<? super Void, ? super Throwable>	Returns: a `BiConsumer` that completes this callback asBiConsumer() Converts this callback into a `BiConsumer` that can be passed to `CompletableFuture#whenComplete(BiConsumer)`.
public default void	fail(Throwable the failure x) Method to invoke to fail the callback.
public static Callback	Returns: a new callback from(Runnable the success action to invoke when the callback succeeds success, Consumer<Throwable> the failure consumer to invoke when the callback fails failure) Creates a callback from the given success and failure lambdas.
public default void	succeed() Method to invoke to succeed the callback.

NOOP	back to summary
public static final Callback NOOP Empty implementation.

Method Detail

asBiConsumer back to summary

asBiConsumer	back to summary
public default BiConsumer<? super Void, ? super Throwable> asBiConsumer() Converts this callback into a `BiConsumer` that can be passed to `CompletableFuture#whenComplete(BiConsumer)`. When the `BiConsumer` is accepted, this callback is completed. Returns:BiConsumer<? super Void, ? super Throwable> a `BiConsumer` that completes this callback See Also `Completable#with(Consumer)`

public default BiConsumer<? super Void, ? super Throwable> asBiConsumer()

Converts this callback into a BiConsumer that can be passed to CompletableFuture#whenComplete(BiConsumer).

When the BiConsumer is accepted, this callback is completed.

Returns:BiConsumer<? super Void, ? super Throwable>: a BiConsumer that completes this callback
See Also: Completable#with(Consumer)

fail	back to summary
public default void fail(Throwable x) Method to invoke to fail the callback. Parameters x:Throwable the failure

fail

back to summary

public default void fail(Throwable x)

Method to invoke to fail the callback.

Parameters

x:Throwable: the failure

from	back to summary
public static Callback from(Runnable success, Consumer<Throwable> failure) Creates a callback from the given success and failure lambdas. Parameters success:Runnable the success action to invoke when the callback succeeds failure:Consumer<Throwable> the failure consumer to invoke when the callback fails Returns:Callback a new callback

from

back to summary

public static Callback from(Runnable success, Consumer<Throwable> failure)

Creates a callback from the given success and failure lambdas.

Parameters

success:Runnable: the success action to invoke when the callback succeeds
failure:Consumer<Throwable>: the failure consumer to invoke when the callback fails

Returns:Callback

a new callback

succeed back to summary

succeed	back to summary
public default void succeed() Method to invoke to succeed the callback. See Also `fail(Throwable)`

public default void succeed()

Method to invoke to succeed the callback.

See Also: fail(Throwable)

org.eclipse.jetty.websocket.api back to summary

public Class Callback.Completable

Class Inheritance

extends CompletableFuture<Void>
implements Callback

java.lang.Object
java.util.concurrent.CompletableFuture
org.eclipse.jetty.websocket.api.Callback.Completable

All Implemented Interfaces

org.eclipse.jetty.websocket.api.Callback

A Callback that is also a CompletableFuture.

Applications can pass an instance of this class as a Callback, but also use the CompletableFuture APIs.

Constructor Summary

Access	Constructor and Description
public	Completable()

Method Summary

Modifier and Type	Method and Description
public Callback.Completable	Returns: a new `Completable` passed to the consumer compose(Consumer<Callback.Completable> the consumer that receives the `Completable` consumer) Returns a new `Completable` that, when this `Completable` succeeds, is passed to the given consumer and then returned.
public void	fail(Throwable the failure x) Overrides default org.eclipse.jetty.websocket.api.Callback.fail. Method to invoke to fail the callback.
public void	succeed() Overrides default org.eclipse.jetty.websocket.api.Callback.succeed. Method to invoke to succeed the callback.
public static Callback.Completable	Returns: a new completable passed to the consumer with(Consumer<Callback.Completable> the consumer that receives the completable consumer) Convenience method that creates a `Completable` that is passed to the given consumer and then returned.

Inherited from java.util.concurrent.CompletableFuture:: acceptEither acceptEitherAsync acceptEitherAsync allOf anyOf applyToEither applyToEitherAsync applyToEitherAsync cancel complete completeAsync completeAsync completedFuture completedStage completeExceptionally completeOnTimeout copy defaultExecutor delayedExecutor delayedExecutor exceptionally exceptionallyAsync exceptionallyAsync exceptionallyCompose exceptionallyComposeAsync exceptionallyComposeAsync exceptionNow failedFuture failedStage get get getNow getNumberOfDependents handle handleAsync handleAsync isCancelled isCompletedExceptionally isDone join minimalCompletionStage newIncompleteFuture obtrudeException obtrudeValue orTimeout resultNow runAfterBoth runAfterBothAsync runAfterBothAsync runAfterEither runAfterEitherAsync runAfterEitherAsync runAsync runAsync state supplyAsync supplyAsync thenAccept thenAcceptAsync thenAcceptAsync thenAcceptBoth thenAcceptBothAsync thenAcceptBothAsync thenApply thenApplyAsync thenApplyAsync thenCombine thenCombineAsync thenCombineAsync thenCompose thenComposeAsync thenComposeAsync thenRun thenRunAsync thenRunAsync toCompletableFuture toString whenComplete whenCompleteAsync whenCompleteAsync

Constructor Detail

Completable	back to summary
public Completable()

Method Detail

compose back to summary

compose	back to summary
public Callback.Completable compose(Consumer<Callback.Completable> consumer) Returns a new `Completable` that, when this `Completable` succeeds, is passed to the given consumer and then returned. If this `Completable` fails, the new `Completable` is also failed, and the consumer is not invoked. For example: `Callback.Completable.with(completable1 -> session.sendPartialText("hello", false, completable1)) .compose(completable2 -> session.sendPartialText(" ", false, completable2)) .compose(completable3 -> session.sendPartialText("world", true, completable3)) .thenRun(session::demand);` Parameters consumer:Consumer<Callback.Completable> the consumer that receives the `Completable` Returns:Callback.Completable a new `Completable` passed to the consumer See Also `with(Consumer)`

public Callback.Completable compose(Consumer<Callback.Completable> consumer)

Returns a new Completable that, when this Completable succeeds, is passed to the given consumer and then returned.

If this Completable fails, the new Completable is also failed, and the consumer is not invoked.

For example:

Callback.Completable.with(completable1 -> session.sendPartialText("hello", false, completable1))
    .compose(completable2 -> session.sendPartialText(" ", false, completable2))
    .compose(completable3 -> session.sendPartialText("world", true, completable3))
    .thenRun(session::demand);

Parameters

consumer:Consumer<Callback.Completable>: the consumer that receives the Completable

Returns:Callback.Completable

a new Completable passed to the consumer

See Also

with(Consumer)

fail	back to summary
public void fail(Throwable x) Overrides default org.eclipse.jetty.websocket.api.Callback.fail. Doc from org.eclipse.jetty.websocket.api.Callback.fail. Method to invoke to fail the callback. Parameters x:Throwable the failure Annotations @Override

fail

back to summary

public void fail(Throwable x)

Overrides default org.eclipse.jetty.websocket.api.Callback.fail.

Doc from org.eclipse.jetty.websocket.api.Callback.fail.

Method to invoke to fail the callback.

Parameters

x:Throwable: the failure

Annotations

@Override

succeed	back to summary
public void succeed() Overrides default org.eclipse.jetty.websocket.api.Callback.succeed. Doc from org.eclipse.jetty.websocket.api.Callback.succeed. Method to invoke to succeed the callback. Annotations @Override

succeed

back to summary

public void succeed()

Overrides default org.eclipse.jetty.websocket.api.Callback.succeed.

Doc from org.eclipse.jetty.websocket.api.Callback.succeed.

Method to invoke to succeed the callback.

Annotations

@Override

with back to summary

with	back to summary
public static Callback.Completable with(Consumer<Callback.Completable> consumer) Convenience method that creates a `Completable` that is passed to the given consumer and then returned. For example: `Completable.with(completable -> session.sendText("TEXT", completable)) .thenRun(session::demand);` Parameters consumer:Consumer<Callback.Completable> the consumer that receives the completable Returns:Callback.Completable a new completable passed to the consumer See Also `compose(Consumer)`

public static Callback.Completable with(Consumer<Callback.Completable> consumer)

Convenience method that creates a Completable that is passed to the given consumer and then returned.

For example:

Completable.with(completable -> session.sendText("TEXT", completable))
    .thenRun(session::demand);

Parameters

consumer:Consumer<Callback.Completable>: the consumer that receives the completable

Returns:Callback.Completable

a new completable passed to the consumer

See Also

compose(Consumer)

public Interface Callback

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class Callback.Completable

Constructor Summary

Method Summary

Constructor Detail

Method Detail