WebSockets (Undertow 1.3.0.CR1 API)

java.lang.Object
- io.undertow.websockets.core.WebSockets

```
public class WebSockets
extends Object
```
Author:

Stuart Douglas

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ByteBuffer`	`mergeBuffers(ByteBuffer... payload)`
`static void`	`sendBinary(ByteBuffer[] data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete text message, invoking the callback when complete
`static void`	`sendBinary(ByteBuffer[] data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback, long timeoutmillis)` Sends a complete text message, invoking the callback when complete
`static void`	`sendBinary(ByteBuffer data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete text message, invoking the callback when complete
`static void`	`sendBinary(ByteBuffer data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback, long timeoutmillis)` Sends a complete text message, invoking the callback when complete
`static void`	`sendBinaryBlocking(ByteBuffer[] data, WebSocketChannel wsChannel)` Sends a complete binary message using blocking IO
`static void`	`sendBinaryBlocking(ByteBuffer data, WebSocketChannel wsChannel)` Sends a complete binary message using blocking IO
`static void`	`sendClose(ByteBuffer[] data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete close message, invoking the callback when complete
`static void`	`sendClose(ByteBuffer data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete close message, invoking the callback when complete
`static void`	`sendClose(CloseMessage closeMessage, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete close message, invoking the callback when complete
`static void`	`sendClose(int code, String reason, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete close message, invoking the callback when complete
`static void`	`sendCloseBlocking(ByteBuffer[] data, WebSocketChannel wsChannel)` Sends a complete close message, invoking the callback when complete
`static void`	`sendCloseBlocking(ByteBuffer data, WebSocketChannel wsChannel)` Sends a complete close message, invoking the callback when complete
`static void`	`sendCloseBlocking(CloseMessage closeMessage, WebSocketChannel wsChannel)` Sends a complete close message, invoking the callback when complete
`static void`	`sendCloseBlocking(int code, String reason, WebSocketChannel wsChannel)` Sends a complete close message, invoking the callback when complete
`static void`	`sendPing(ByteBuffer[] data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete ping message, invoking the callback when complete
`static void`	`sendPing(ByteBuffer[] data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback, long timeoutmillis)` Sends a complete ping message, invoking the callback when complete
`static void`	`sendPing(ByteBuffer data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete ping message, invoking the callback when complete
`static void`	`sendPing(ByteBuffer data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback, long timeoutmillis)` Sends a complete ping message, invoking the callback when complete
`static void`	`sendPingBlocking(ByteBuffer[] data, WebSocketChannel wsChannel)` Sends a complete ping message using blocking IO
`static void`	`sendPingBlocking(ByteBuffer data, WebSocketChannel wsChannel)` Sends a complete ping message using blocking IO
`static void`	`sendPong(ByteBuffer[] data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete pong message, invoking the callback when complete
`static void`	`sendPong(ByteBuffer[] data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback, long timeoutmillis)` Sends a complete pong message, invoking the callback when complete
`static void`	`sendPong(ByteBuffer data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete pong message, invoking the callback when complete
`static void`	`sendPong(ByteBuffer data, WebSocketChannel wsChannel, WebSocketCallback<Void> callback, long timeoutmillis)` Sends a complete pong message, invoking the callback when complete
`static void`	`sendPongBlocking(ByteBuffer[] data, WebSocketChannel wsChannel)` Sends a complete pong message using blocking IO
`static void`	`sendPongBlocking(ByteBuffer data, WebSocketChannel wsChannel)` Sends a complete pong message using blocking IO
`static void`	`sendText(ByteBuffer message, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete text message, invoking the callback when complete
`static void`	`sendText(ByteBuffer message, WebSocketChannel wsChannel, WebSocketCallback<Void> callback, long timeoutmillis)` Sends a complete text message, invoking the callback when complete
`static void`	`sendText(String message, WebSocketChannel wsChannel, WebSocketCallback<Void> callback)` Sends a complete text message, invoking the callback when complete
`static void`	`sendText(String message, WebSocketChannel wsChannel, WebSocketCallback<Void> callback, long timeoutmillis)` Sends a complete text message, invoking the callback when complete
`static void`	`sendTextBlocking(ByteBuffer message, WebSocketChannel wsChannel)` Sends a complete text message, invoking the callback when complete
`static void`	`sendTextBlocking(String message, WebSocketChannel wsChannel)` Sends a complete text message, invoking the callback when complete

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

sendText

public static void sendText(String message,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback)

Sends a complete text message, invoking the callback when complete

Parameters:: message -; wsChannel -; callback -

sendText

public static void sendText(String message,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback,
                            long timeoutmillis)

Sends a complete text message, invoking the callback when complete

Parameters:: message -; wsChannel -; callback -; timeoutmillis - the timeout in milliseconds

sendText

public static void sendText(ByteBuffer message,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback)

Sends a complete text message, invoking the callback when complete

Parameters:: message -; wsChannel -; callback -

sendText

public static void sendText(ByteBuffer message,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback,
                            long timeoutmillis)

Sends a complete text message, invoking the callback when complete

Parameters:: message -; wsChannel -; callback -

sendTextBlocking

public static void sendTextBlocking(String message,
                                    WebSocketChannel wsChannel)
                             throws IOException

Sends a complete text message, invoking the callback when complete

Parameters:: message -; wsChannel -
Throws:: IOException

sendTextBlocking

public static void sendTextBlocking(ByteBuffer message,
                                    WebSocketChannel wsChannel)
                             throws IOException

Sends a complete text message, invoking the callback when complete

Parameters:: message -; wsChannel -
Throws:: IOException

sendPing

public static void sendPing(ByteBuffer data,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback)

Sends a complete ping message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendPing

public static void sendPing(ByteBuffer data,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback,
                            long timeoutmillis)

Sends a complete ping message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendPing

public static void sendPing(ByteBuffer[] data,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback)

Sends a complete ping message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendPing

public static void sendPing(ByteBuffer[] data,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback,
                            long timeoutmillis)

Sends a complete ping message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendPingBlocking

public static void sendPingBlocking(ByteBuffer data,
                                    WebSocketChannel wsChannel)
                             throws IOException

Sends a complete ping message using blocking IO

Parameters:: data -; wsChannel -
Throws:: IOException

sendPingBlocking

public static void sendPingBlocking(ByteBuffer[] data,
                                    WebSocketChannel wsChannel)
                             throws IOException

Sends a complete ping message using blocking IO

Parameters:: data -; wsChannel -
Throws:: IOException

sendPong

public static void sendPong(ByteBuffer data,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback)

Sends a complete pong message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendPong

public static void sendPong(ByteBuffer data,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback,
                            long timeoutmillis)

Sends a complete pong message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendPong

public static void sendPong(ByteBuffer[] data,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback)

Sends a complete pong message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendPong

public static void sendPong(ByteBuffer[] data,
                            WebSocketChannel wsChannel,
                            WebSocketCallback<Void> callback,
                            long timeoutmillis)

Sends a complete pong message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendPongBlocking

public static void sendPongBlocking(ByteBuffer data,
                                    WebSocketChannel wsChannel)
                             throws IOException

Sends a complete pong message using blocking IO

Parameters:: data -; wsChannel -
Throws:: IOException

sendPongBlocking

public static void sendPongBlocking(ByteBuffer[] data,
                                    WebSocketChannel wsChannel)
                             throws IOException

Sends a complete pong message using blocking IO

Parameters:: data -; wsChannel -
Throws:: IOException

sendBinary

public static void sendBinary(ByteBuffer data,
                              WebSocketChannel wsChannel,
                              WebSocketCallback<Void> callback)

Sends a complete text message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendBinary

public static void sendBinary(ByteBuffer data,
                              WebSocketChannel wsChannel,
                              WebSocketCallback<Void> callback,
                              long timeoutmillis)

Sends a complete text message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendBinary

public static void sendBinary(ByteBuffer[] data,
                              WebSocketChannel wsChannel,
                              WebSocketCallback<Void> callback)

Sends a complete text message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendBinary

public static void sendBinary(ByteBuffer[] data,
                              WebSocketChannel wsChannel,
                              WebSocketCallback<Void> callback,
                              long timeoutmillis)

Sends a complete text message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendBinaryBlocking

public static void sendBinaryBlocking(ByteBuffer data,
                                      WebSocketChannel wsChannel)
                               throws IOException

Sends a complete binary message using blocking IO

Parameters:: data -; wsChannel -
Throws:: IOException

sendBinaryBlocking

public static void sendBinaryBlocking(ByteBuffer[] data,
                                      WebSocketChannel wsChannel)
                               throws IOException

Sends a complete binary message using blocking IO

Parameters:: data -; wsChannel -
Throws:: IOException

sendClose

public static void sendClose(ByteBuffer data,
                             WebSocketChannel wsChannel,
                             WebSocketCallback<Void> callback)

Sends a complete close message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendClose

public static void sendClose(ByteBuffer[] data,
                             WebSocketChannel wsChannel,
                             WebSocketCallback<Void> callback)

Sends a complete close message, invoking the callback when complete

Parameters:: data -; wsChannel -; callback -

sendClose

public static void sendClose(int code,
                             String reason,
                             WebSocketChannel wsChannel,
                             WebSocketCallback<Void> callback)

Sends a complete close message, invoking the callback when complete

Parameters:: code - The close code; wsChannel -; callback -

sendClose

public static void sendClose(CloseMessage closeMessage,
                             WebSocketChannel wsChannel,
                             WebSocketCallback<Void> callback)

Sends a complete close message, invoking the callback when complete

Parameters:: closeMessage - The close message; wsChannel -; callback -

sendCloseBlocking

public static void sendCloseBlocking(CloseMessage closeMessage,
                                     WebSocketChannel wsChannel)
                              throws IOException

Sends a complete close message, invoking the callback when complete

Parameters:: closeMessage - the close message; wsChannel -
Throws:: IOException

sendCloseBlocking

public static void sendCloseBlocking(int code,
                                     String reason,
                                     WebSocketChannel wsChannel)
                              throws IOException

Sends a complete close message, invoking the callback when complete

Parameters:: code -; wsChannel -
Throws:: IOException

sendCloseBlocking

public static void sendCloseBlocking(ByteBuffer data,
                                     WebSocketChannel wsChannel)
                              throws IOException

Sends a complete close message, invoking the callback when complete

Parameters:: data -; wsChannel -
Throws:: IOException

sendCloseBlocking

public static void sendCloseBlocking(ByteBuffer[] data,
                                     WebSocketChannel wsChannel)
                              throws IOException

Sends a complete close message, invoking the callback when complete

Parameters:: data -; wsChannel -
Throws:: IOException

mergeBuffers

public static ByteBuffer mergeBuffers(ByteBuffer... payload)

Class WebSockets

Method Summary

Methods inherited from class java.lang.Object

Method Detail

sendText

sendText

sendText

sendText

sendTextBlocking

sendTextBlocking

sendPing

sendPing

sendPing

sendPing

sendPingBlocking

sendPingBlocking

sendPong

sendPong

sendPong

sendPong

sendPongBlocking

sendPongBlocking

sendBinary

sendBinary

sendBinary

sendBinary

sendBinaryBlocking

sendBinaryBlocking

sendClose

sendClose

sendClose

sendClose

sendCloseBlocking

sendCloseBlocking

sendCloseBlocking

sendCloseBlocking

mergeBuffers