public class NettyWebSocket extends Object implements WebSocket
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 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) |
Modifier and Type | Method and Description |
---|---|
WebSocket |
addWebSocketListener(WebSocketListener l)
Add a
WebSocketListener |
void |
bufferFrame(io.netty.handler.codec.http.websocketx.WebSocketFrame frame) |
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() |
void |
handleFrame(io.netty.handler.codec.http.websocketx.WebSocketFrame frame) |
boolean |
isOpen() |
boolean |
isReady() |
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) |
void |
processBufferedFrames() |
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() |
protected final io.netty.channel.Channel channel
protected final io.netty.handler.codec.http.HttpHeaders upgradeHeaders
protected final Collection<WebSocketListener> listeners
public NettyWebSocket(io.netty.channel.Channel channel, io.netty.handler.codec.http.HttpHeaders upgradeHeaders)
public NettyWebSocket(io.netty.channel.Channel channel, io.netty.handler.codec.http.HttpHeaders upgradeHeaders, Collection<WebSocketListener> listeners)
public boolean isReady()
public void bufferFrame(io.netty.handler.codec.http.websocketx.WebSocketFrame frame)
public void processBufferedFrames()
public void handleFrame(io.netty.handler.codec.http.websocketx.WebSocketFrame frame)
public io.netty.handler.codec.http.HttpHeaders getUpgradeHeaders()
getUpgradeHeaders
in interface WebSocket
public SocketAddress getRemoteAddress()
WebSocket
getRemoteAddress
in interface WebSocket
null
if asynchronous provider is unable to provide the remote addresspublic SocketAddress getLocalAddress()
WebSocket
getLocalAddress
in interface WebSocket
null
if asynchronous provider is unable to provide the local addresspublic WebSocket sendMessage(byte[] message)
WebSocket
sendMessage
in interface WebSocket
message
- a byte messagepublic WebSocket sendMessage(byte[] message, WebSocketWriteCompleteListener listener)
WebSocket
sendMessage
in interface WebSocket
message
- a byte messagelistener
- is notified when a message was successfully processed by the channel or in case of failurepublic WebSocket stream(byte[] fragment, boolean last)
WebSocket
public WebSocket stream(byte[] fragment, boolean last, WebSocketWriteCompleteListener listener)
WebSocket
public WebSocket stream(byte[] fragment, int offset, int len, boolean last)
WebSocket
public WebSocket stream(byte[] fragment, int offset, int len, boolean last, WebSocketWriteCompleteListener listener)
WebSocket
stream
in interface WebSocket
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 failurepublic WebSocket sendMessage(String message)
WebSocket
sendMessage
in interface WebSocket
message
- a text messagepublic WebSocket sendMessage(String message, WebSocketWriteCompleteListener listener)
WebSocket
sendMessage
in interface WebSocket
message
- a text messagelistener
- is notified when a message was successfully processed by the channel or in case of failurepublic WebSocket stream(String fragment, boolean last)
WebSocket
public WebSocket stream(String fragment, boolean last, WebSocketWriteCompleteListener listener)
WebSocket
public WebSocket sendPing(byte[] payload)
WebSocket
ping
with an optional payload (limited to 125 bytes or less).public WebSocket sendPing(byte[] payload, WebSocketWriteCompleteListener listener)
WebSocket
ping
with an optional payload (limited to 125 bytes or less).public WebSocket sendPong(byte[] payload)
WebSocket
ping
with an optional payload (limited to 125 bytes or less).public WebSocket sendPong(byte[] payload, WebSocketWriteCompleteListener listener)
WebSocket
ping
with an optional payload (limited to 125 bytes or less).public boolean isOpen()
public void close()
close
in interface Closeable
close
in interface AutoCloseable
public void close(int statusCode, String reason)
public void onError(Throwable t)
public void onClose(int code, String reason)
public WebSocket addWebSocketListener(WebSocketListener l)
WebSocket
WebSocketListener
addWebSocketListener
in interface WebSocket
l
- a WebSocketListener
public WebSocket removeWebSocketListener(WebSocketListener l)
WebSocket
WebSocketListener
removeWebSocketListener
in interface WebSocket
l
- a WebSocketListener
public void onBinaryFrame(io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame frame)
public void onTextFrame(io.netty.handler.codec.http.websocketx.TextWebSocketFrame frame)
public void onPing(io.netty.handler.codec.http.websocketx.PingWebSocketFrame frame)
public void onPong(io.netty.handler.codec.http.websocketx.PongWebSocketFrame frame)
Copyright © 2017. All Rights Reserved.