com.mulesoft.service.http.impl.service.ws

Class WebSocketUtils

java.lang.Object

com.mulesoft.service.http.impl.service.ws.WebSocketUtils

public final class WebSocketUtils
extends Object

Utility methods for implementing WebSockets

Since:

1.3.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DATA_FRAME_SIZE

Constructor Summary

Constructors

Constructor and Description
WebSocketUtils()

Method Summary

Modifier and Type	Method and Description
static <T> CompletableFuture<Void>	asVoid(CompletableFuture<T> future) Returns a void CompletableFuture that completes when the input future does.
static <T> CompletableFuture<Void>	asVoid(CompletableFuture<T> future, Function<Throwable,Throwable> exceptionMapper) Returns a void CompletableFuture that completes when the input future does.
static <T> CompletableFuture<Void>	asVoid(org.glassfish.grizzly.GrizzlyFuture<T> future) Returns a void CompletableFuture that completes when the input future does.
static <T> CompletableFuture<Void>	asVoid(org.glassfish.grizzly.GrizzlyFuture<T> future, Function<Throwable,Throwable> exceptionMapper) Returns a void CompletableFuture that completes when the input future does.
static <T> CompletableFuture<T>	failedFuture(Throwable t) Returns a CompletableFuture immediately and exceptionally completed with the given t
static Throwable	mapWsException(Throwable t, org.mule.runtime.http.api.ws.WebSocket webSocket) Maps Grizzly Throwable instances to Mule ones as defined in the Http Service API.
static CompletableFuture<Void>	streamInDataFrames(InputStream content, DataFrameEmitter emitter, Function<Throwable,Throwable> exceptionMapper)
static CompletableFuture<Void>	streamInDataFrames(InputStream content, int frameSize, DataFrameEmitter emitter, Function<Throwable,Throwable> exceptionMapper)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATA_FRAME_SIZE

public static final int DEFAULT_DATA_FRAME_SIZE

See Also:

Constant Field Values

Constructor Detail

WebSocketUtils

public WebSocketUtils()

Method Detail

streamInDataFrames

public static CompletableFuture<Void> streamInDataFrames(InputStream content,
                                                         DataFrameEmitter emitter,
                                                         Function<Throwable,Throwable> exceptionMapper)

streamInDataFrames

public static CompletableFuture<Void> streamInDataFrames(InputStream content,
                                                         int frameSize,
                                                         DataFrameEmitter emitter,
                                                         Function<Throwable,Throwable> exceptionMapper)

asVoid

public static <T> CompletableFuture<Void> asVoid(CompletableFuture<T> future)

Returns a void CompletableFuture that completes when the input future does. Exceptional completions are also propagated using the same completion exception.

Type Parameters:

T - the generic type of the original future.

Parameters:

future - a CompletableFuture of a random type

Returns:

a void CompletableFuture

asVoid

public static <T> CompletableFuture<Void> asVoid(CompletableFuture<T> future,
                                                 Function<Throwable,Throwable> exceptionMapper)

Returns a void CompletableFuture that completes when the input future does. Exceptional completions are also propagated but mapped through the exceptionMapper

Type Parameters:

T - the generic type of the original future.

Parameters:

future - a CompletableFuture of a random type

Returns:

a void CompletableFuture

asVoid

public static <T> CompletableFuture<Void> asVoid(org.glassfish.grizzly.GrizzlyFuture<T> future)

Returns a void CompletableFuture that completes when the input future does. Exceptional completions are also propagated using the same completion exception.

Type Parameters:

T - the generic type of the original future.

Parameters:

future - a CompletableFuture of a random type

Returns:

a void CompletableFuture

asVoid

public static <T> CompletableFuture<Void> asVoid(org.glassfish.grizzly.GrizzlyFuture<T> future,
                                                 Function<Throwable,Throwable> exceptionMapper)

Returns a void CompletableFuture that completes when the input future does. Exceptional completions are also propagated but mapped through the exceptionMapper

Type Parameters:

T - the generic type of the original future.

Parameters:

future - a CompletableFuture of a random type

Returns:

a void CompletableFuture

failedFuture

public static <T> CompletableFuture<T> failedFuture(Throwable t)

Returns a CompletableFuture immediately and exceptionally completed with the given t

Type Parameters:

T - the generic type of the future

Parameters:

t - a Throwable

Returns:

a CompletableFuture

mapWsException

public static Throwable mapWsException(Throwable t,
                                       org.mule.runtime.http.api.ws.WebSocket webSocket)

Maps Grizzly Throwable instances to Mule ones as defined in the Http Service API.

Parameters:

t - the Throwable to be mapped

webSocket - the WebSocket referred by the potentially mapped exception.

Returns:

a mapped Throwable or the same input instance.