org.mule.runtime.http.api.ws

Interface WebSocketBroadcaster

@Experimental
public interface WebSocketBroadcaster

Broadcasts a given content to a group of supplied sockets. Instances are not be assumed reusable.

Since:

1.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.

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.

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 broadcasted to all sockets