org.asynchttpclient.netty.ws

Class NettyWebSocket

java.lang.Object

org.asynchttpclient.netty.ws.NettyWebSocket

All Implemented Interfaces:

Closeable, AutoCloseable, WebSocket

public class NettyWebSocket
extends Object
implements WebSocket

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.channel.Channel	channel
protected Collection<WebSocketListener>	listeners
protected io.netty.handler.codec.http.HttpHeaders	upgradeHeaders

Constructor Summary

Constructors

Constructor and Description
NettyWebSocket(io.netty.channel.Channel channel, io.netty.handler.codec.http.HttpHeaders upgradeHeaders)
NettyWebSocket(io.netty.channel.Channel channel, io.netty.handler.codec.http.HttpHeaders upgradeHeaders, Collection<WebSocketListener> listeners)

Method Summary

Modifier and Type	Method and Description
WebSocket	addWebSocketListener(WebSocketListener l) Add a WebSocketListener
void	close()
void	close(int statusCode, String reason)
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()
void	onBinaryFrame(io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame frame)
void	onClose(int code, String reason)
void	onError(Throwable t)
void	onPing(io.netty.handler.codec.http.websocketx.PingWebSocketFrame frame)
void	onPong(io.netty.handler.codec.http.websocketx.PongWebSocketFrame frame)
void	onTextFrame(io.netty.handler.codec.http.websocketx.TextWebSocketFrame frame)
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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

channel

protected final io.netty.channel.Channel channel

upgradeHeaders

protected final io.netty.handler.codec.http.HttpHeaders upgradeHeaders

listeners

protected final Collection<WebSocketListener> listeners

Constructor Detail

NettyWebSocket

public NettyWebSocket(io.netty.channel.Channel channel,
                      io.netty.handler.codec.http.HttpHeaders upgradeHeaders)

NettyWebSocket

public NettyWebSocket(io.netty.channel.Channel channel,
                      io.netty.handler.codec.http.HttpHeaders upgradeHeaders,
                      Collection<WebSocketListener> listeners)

Method Detail

getUpgradeHeaders

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

Specified by:

getUpgradeHeaders in interface WebSocket

Returns:

the headers received in the Upgrade response

getRemoteAddress

public SocketAddress getRemoteAddress()

Description copied from interface: WebSocket

Get remote address client initiated request to.

Specified by:

getRemoteAddress in interface WebSocket

Returns:

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

getLocalAddress

public SocketAddress getLocalAddress()

Description copied from interface: WebSocket

Get local address client initiated request from.

Specified by:

getLocalAddress in interface WebSocket

Returns:

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

sendMessage

public WebSocket sendMessage(byte[] message)

Description copied from interface: WebSocket

Send a byte message.

Specified by:

sendMessage in interface WebSocket

Parameters:

message - a byte message

Returns:

this

sendMessage

public WebSocket sendMessage(byte[] message,
                             WebSocketWriteCompleteListener listener)

Description copied from interface: WebSocket

Send a byte message.

Specified by:

sendMessage in interface WebSocket

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

public WebSocket stream(byte[] fragment,
                        boolean last)

Description copied from interface: WebSocket

Allows streaming of multiple binary fragments.

Specified by:

stream in interface WebSocket

Parameters:

fragment - binary fragment.

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

Returns:

this

stream

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

Description copied from interface: WebSocket

Allows streaming of multiple binary fragments.

Specified by:

stream in interface WebSocket

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

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

Description copied from interface: WebSocket

Allows streaming of multiple binary fragments.

Specified by:

stream in interface WebSocket

Parameters:

fragment - binary fragment.

offset - starting offset.

len - length.

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

Returns:

this

stream

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

Description copied from interface: WebSocket

Allows streaming of multiple binary fragments.

Specified by:

stream in interface WebSocket

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

public WebSocket sendMessage(String message)

Description copied from interface: WebSocket

Send a text message

Specified by:

sendMessage in interface WebSocket

Parameters:

message - a text message

Returns:

this

sendMessage

public WebSocket sendMessage(String message,
                             WebSocketWriteCompleteListener listener)

Description copied from interface: WebSocket

Send a text message

Specified by:

sendMessage in interface WebSocket

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

public WebSocket stream(String fragment,
                        boolean last)

Description copied from interface: WebSocket

Allows streaming of multiple text fragments.

Specified by:

stream in interface WebSocket

Parameters:

fragment - text fragment.

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

Returns:

this

stream

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

Description copied from interface: WebSocket

Allows streaming of multiple text fragments.

Specified by:

stream in interface WebSocket

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

public WebSocket sendPing(byte[] payload)

Description copied from interface: WebSocket

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

Specified by:

sendPing in interface WebSocket

Parameters:

payload - the ping payload.

Returns:

this

sendPing

public WebSocket sendPing(byte[] payload,
                          WebSocketWriteCompleteListener listener)

Description copied from interface: WebSocket

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

Specified by:

sendPing in interface WebSocket

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

public WebSocket sendPong(byte[] payload)

Description copied from interface: WebSocket

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

Specified by:

sendPong in interface WebSocket

Parameters:

payload - the pong payload.

Returns:

this

sendPong

public WebSocket sendPong(byte[] payload,
                          WebSocketWriteCompleteListener listener)

Description copied from interface: WebSocket

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

Specified by:

sendPong in interface WebSocket

Parameters:

payload - the pong payload.

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

Returns:

this

isOpen

public boolean isOpen()

Specified by:

isOpen in interface WebSocket

Returns:

true if the WebSocket is open/connected.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

close

public void close(int statusCode,
                  String reason)

onError

public void onError(Throwable t)

onClose

public void onClose(int code,
                    String reason)

toString

public String toString()

Overrides:

toString in class Object

addWebSocketListener

public WebSocket addWebSocketListener(WebSocketListener l)

Description copied from interface: WebSocket

Add a WebSocketListener

Specified by:

addWebSocketListener in interface WebSocket

Parameters:

l - a WebSocketListener

Returns:

this

removeWebSocketListener

public WebSocket removeWebSocketListener(WebSocketListener l)

Description copied from interface: WebSocket

Remove a WebSocketListener

Specified by:

removeWebSocketListener in interface WebSocket

Parameters:

l - a WebSocketListener

Returns:

this

onBinaryFrame

public void onBinaryFrame(io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame frame)

onTextFrame

public void onTextFrame(io.netty.handler.codec.http.websocketx.TextWebSocketFrame frame)

onPing

public void onPing(io.netty.handler.codec.http.websocketx.PingWebSocketFrame frame)

onPong

public void onPong(io.netty.handler.codec.http.websocketx.PongWebSocketFrame frame)