org.asynchttpclient.ws

Interface WebSocket

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

NettyWebSocket

public interface WebSocket
extends Closeable

A WebSocket client

Method Summary

Modifier and Type	Method and Description
WebSocket	addWebSocketListener(WebSocketListener l) Add a WebSocketListener
SocketAddress	getLocalAddress() Get local address client initiated request from.
SocketAddress	getRemoteAddress() Get remote address client initiated request to.
io.netty.handler.codec.http.HttpHeaders	getUpgradeHeaders()
boolean	isOpen()
WebSocket	removeWebSocketListener(WebSocketListener l) Remove a WebSocketListener
WebSocket	sendMessage(byte[] message) Send a byte message.
WebSocket	sendMessage(byte[] message, WebSocketWriteCompleteListener listener) Send a byte message.
WebSocket	sendMessage(String message) Send a text message
WebSocket	sendMessage(String message, WebSocketWriteCompleteListener listener) Send a text message
WebSocket	sendPing(byte[] payload) Send a ping with an optional payload (limited to 125 bytes or less).
WebSocket	sendPing(byte[] payload, WebSocketWriteCompleteListener listener) Send a ping with an optional payload (limited to 125 bytes or less).
WebSocket	sendPong(byte[] payload) Send a ping with an optional payload (limited to 125 bytes or less).
WebSocket	sendPong(byte[] payload, WebSocketWriteCompleteListener listener) Send a ping with an optional payload (limited to 125 bytes or less).
WebSocket	stream(byte[] fragment, boolean last) Allows streaming of multiple binary fragments.
WebSocket	stream(byte[] fragment, boolean last, WebSocketWriteCompleteListener listener) Allows streaming of multiple binary fragments.
WebSocket	stream(byte[] fragment, int offset, int len, boolean last) Allows streaming of multiple binary fragments.
WebSocket	stream(byte[] fragment, int offset, int len, boolean last, WebSocketWriteCompleteListener listener) Allows streaming of multiple binary fragments.
WebSocket	stream(String fragment, boolean last) Allows streaming of multiple text fragments.
WebSocket	stream(String fragment, boolean last, WebSocketWriteCompleteListener listener) Allows streaming of multiple text fragments.

Methods inherited from interface java.io.Closeable

close

Method Detail

getUpgradeHeaders

io.netty.handler.codec.http.HttpHeaders getUpgradeHeaders()

Returns:

the headers received in the Upgrade response

getRemoteAddress

SocketAddress getRemoteAddress()

Get remote address client initiated request to.

Returns:

remote address client initiated request to, may be null if asynchronous provider is unable to provide the remote address

getLocalAddress

SocketAddress getLocalAddress()

Get local address client initiated request from.

Returns:

local address client initiated request from, may be null if asynchronous provider is unable to provide the local address

sendMessage

WebSocket sendMessage(byte[] message)

Send a byte message.

Parameters:

message - a byte message

Returns:

this

sendMessage

WebSocket sendMessage(byte[] message,
                      WebSocketWriteCompleteListener listener)

Send a byte message.

Parameters:

message - a byte message

listener - is notified when a message was successfully processed by the channel or in case of failure

Returns:

this

stream

WebSocket stream(byte[] fragment,
                 boolean last)

Allows streaming of multiple binary fragments.

Parameters:

fragment - binary fragment.

last - flag indicating whether or not this is the last fragment.

Returns:

this

stream

WebSocket stream(byte[] fragment,
                 boolean last,
                 WebSocketWriteCompleteListener listener)

Allows streaming of multiple binary fragments.

Parameters:

fragment - binary fragment.

last - flag indicating whether or not this is the last fragment.

listener - is notified when a fragment was successfully processed by the channel or in case of failure

Returns:

this

stream

WebSocket stream(byte[] fragment,
                 int offset,
                 int len,
                 boolean last)

Allows streaming of multiple binary fragments.

Parameters:

fragment - binary fragment.

offset - starting offset.

len - length.

last - flag indicating whether or not this is the last fragment.

Returns:

this

stream

WebSocket stream(byte[] fragment,
                 int offset,
                 int len,
                 boolean last,
                 WebSocketWriteCompleteListener listener)

Allows streaming of multiple binary fragments.

Parameters:

fragment - binary fragment.

offset - starting offset.

len - length.

last - flag indicating whether or not this is the last fragment.

listener - is notified when a fragment was successfully processed by the channel or in case of failure

Returns:

this

sendMessage

WebSocket sendMessage(String message)

Send a text message

Parameters:

message - a text message

Returns:

this

sendMessage

WebSocket sendMessage(String message,
                      WebSocketWriteCompleteListener listener)

Send a text message

Parameters:

message - a text message

listener - is notified when a message was successfully processed by the channel or in case of failure

Returns:

this

stream

WebSocket stream(String fragment,
                 boolean last)

Allows streaming of multiple text fragments.

Parameters:

fragment - text fragment.

last - flag indicating whether or not this is the last fragment.

Returns:

this

stream

WebSocket stream(String fragment,
                 boolean last,
                 WebSocketWriteCompleteListener listener)

Allows streaming of multiple text fragments.

Parameters:

fragment - text fragment.

last - flag indicating whether or not this is the last fragment.

listener - is notified when a fragment was successfully processed by the channel or in case of failure

Returns:

this

sendPing

WebSocket sendPing(byte[] payload)

Send a ping with an optional payload (limited to 125 bytes or less).

Parameters:

payload - the ping payload.

Returns:

this

sendPing

WebSocket sendPing(byte[] payload,
                   WebSocketWriteCompleteListener listener)

Send a ping with an optional payload (limited to 125 bytes or less).

Parameters:

payload - the ping payload.

listener - is notified when the ping was successfully processed by the channel or in case of failure

Returns:

this

sendPong

WebSocket sendPong(byte[] payload)

Send a ping with an optional payload (limited to 125 bytes or less).

Parameters:

payload - the pong payload.

Returns:

this

sendPong

WebSocket sendPong(byte[] payload,
                   WebSocketWriteCompleteListener listener)

Send a ping with an optional payload (limited to 125 bytes or less).

Parameters:

payload - the pong payload.

listener - is notified when the pong was successfully processed by the channel or in case of failure

Returns:

this

addWebSocketListener

WebSocket addWebSocketListener(WebSocketListener l)

Add a WebSocketListener

Parameters:

l - a WebSocketListener

Returns:

this

removeWebSocketListener

WebSocket removeWebSocketListener(WebSocketListener l)

Remove a WebSocketListener

Parameters:

l - a WebSocketListener

Returns:

this

isOpen

boolean isOpen()

Returns:

true if the WebSocket is open/connected.