org.mule.runtime.http.api.ws

Interface WebSocketBroadcaster

@NoImplement
public interface WebSocketBroadcaster

Broadcasts a given content to a group of supplied sockets.

Instances are not to be assumed reusable.

Since:

4.2.0

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	broadcast(Collection<WebSocket> sockets, org.mule.runtime.api.metadata.TypedValue<InputStream> content, BiConsumer<WebSocket,Throwable> errorCallback) Broadcast the content to the given sockets.
CompletableFuture<Void>	broadcast(Collection<WebSocket> sockets, org.mule.runtime.api.metadata.TypedValue<InputStream> content, BiConsumer<WebSocket,Throwable> errorCallback, RetryPolicyTemplate retryPolicyTemplate, org.mule.runtime.api.scheduler.Scheduler reconnectionScheduler) Broadcast the content to the given sockets.

Method Detail

broadcast

CompletableFuture<Void> broadcast(Collection<WebSocket> sockets,
                                  org.mule.runtime.api.metadata.TypedValue<InputStream> content,
                                  BiConsumer<WebSocket,Throwable> errorCallback)

Broadcast the content to the given sockets.

An errorCallback is used to notify errors while broadcasting. If is communication with socket N fails, communication with all the remaining N + M sockets will still be attempted. The callback will be invoked once per failing socket.

Sockets that are either closed or have lost connection will be discarded.

Parameters:

sockets - the sockets to broadcast to

content - the content to be sent

errorCallback - an error notification callback. It will be invoked once per failing socket

Returns:

a CompletableFuture to be completed when the message has been broadcast to all sockets

broadcast

CompletableFuture<Void> broadcast(Collection<WebSocket> sockets,
                                  org.mule.runtime.api.metadata.TypedValue<InputStream> content,
                                  BiConsumer<WebSocket,Throwable> errorCallback,
                                  RetryPolicyTemplate retryPolicyTemplate,
                                  org.mule.runtime.api.scheduler.Scheduler reconnectionScheduler)

Broadcast the content to the given sockets.

An errorCallback is used to notify errors while broadcasting. If is communication with socket N fails, communication with all the remaining N + M sockets will still be attempted. The callback will be invoked once per failing socket.

Sockets that are either closed or have lost connection will be discarded.

Socket that have lost connection to the remote system and support reconnection will be reconnected using the given retryPolicyTemplate and reconnectionScheduler

Parameters:

sockets - the sockets to broadcast to

content - the content to be sent

errorCallback - an error notification callback. It will be invoked once per failing socket

Returns:

a CompletableFuture to be completed when the message has been broadcast to all sockets

Since:

4.2.2