WebSocketConnection (WSO2 Transport HTTP Netty Component 6.3.35 API)

All Known Implementing Classes:

DefaultWebSocketConnection
```
public interface WebSocketConnection
```
Represents successfully opened WebSocket connection.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`io.netty.channel.ChannelFuture`	`finishConnectionClosure()` Finish the connection closure if a close frame has been received without this connection sending a close frame.
`io.netty.channel.ChannelFuture`	`finishConnectionClosure(int statusCode, String reason)` Finish the connection closure if a close frame has been received without this connection sending a close frame.
`String`	`getChannelId()` Retrieve the Channel ID of the connection.
`String`	`getHost()` Retrieve the host of the connection.
`String`	`getNegotiatedSubProtocol()` Retrieve the negotiated sub-protocol during WebSocket handshake.
`int`	`getPort()` Retrieve the port of the connection.
`io.netty.channel.ChannelFuture`	`initiateConnectionClosure()` Initiates connection closure.
`io.netty.channel.ChannelFuture`	`initiateConnectionClosure(int statusCode, String reason)` Initiates connection closure.
`boolean`	`isOpen()` Check if the connection is open.
`boolean`	`isSecure()` Check if the connection is secure.
`io.netty.channel.ChannelFuture`	`ping(ByteBuffer data)` Ping remote endpoint asynchronously.
`io.netty.channel.ChannelFuture`	`pong(ByteBuffer data)` Send pong to remote endpoint asynchronously.
`io.netty.channel.ChannelFuture`	`pushBinary(ByteBuffer data)` Push binary frame to the WebSocket connection asynchronously.
`io.netty.channel.ChannelFuture`	`pushBinary(ByteBuffer data, boolean finalFrame)` Push binary frame to the WebSocket connection asynchronously.
`io.netty.channel.ChannelFuture`	`pushText(String text)` Push text frame to the WebSocket connection asynchronously.
`io.netty.channel.ChannelFuture`	`pushText(String text, boolean finalFrame)` Push text frame to the WebSocket connection asynchronously.
`void`	`readNextFrame()` Reading WebSocket frames after successful handshake is blocked by default in transport level.
`void`	`startReadingFrames()` Reading WebSocket frames after successful handshake is blocked by default in transport level.
`void`	`stopReadingFrames()` Stop reading WebSocket frames from the wire.
`io.netty.channel.ChannelFuture`	`terminateConnection()` Terminate connection without close frame.
`io.netty.channel.ChannelFuture`	`terminateConnection(int statusCode, String reason)` Send a close frame and close the connection without waiting for a response.

- Method Detail
  - getChannelId
```
String getChannelId()
```
    Retrieve the Channel ID of the connection.
    
    Returns:
    
    the channel ID of the connection.
  - isOpen
```
boolean isOpen()
```
    Check if the connection is open.
    
    Returns:
    
    true if the connection is open
  - isSecure
```
boolean isSecure()
```
    Check if the connection is secure.
    
    Returns:
    
    true if the connection is secure
  - getHost
```
String getHost()
```
    Retrieve the host of the connection.
    
    Returns:
    
    the host of the connection.
  - getPort
```
int getPort()
```
    Retrieve the port of the connection.
    
    Returns:
    
    the port of the connection.
  - getNegotiatedSubProtocol
```
String getNegotiatedSubProtocol()
```
    Retrieve the negotiated sub-protocol during WebSocket handshake.
    
    Returns:
    
    the negotiated sub-protocol during WebSocket handshake
  - readNextFrame
```
void readNextFrame()
```
    Reading WebSocket frames after successful handshake is blocked by default in transport level. In order to read the next frame from wire this method should be called.
    Note: This will allow reading frame by frame from the wire. If all frames should be read automatically then startReadingFrames() method should be called.
  - startReadingFrames
```
void startReadingFrames()
```
    Reading WebSocket frames after successful handshake is blocked by default in transport level. In order to start reading WebSocket frames from the wire this method should be called.
    Note: This will allow reading frames automatically from the wire. If frame by frame should be read from the wire readNextFrame() method should be called.
  - stopReadingFrames
```
void stopReadingFrames()
```
    Stop reading WebSocket frames from the wire.
  - pushText
```
io.netty.channel.ChannelFuture pushText(String text)
```
    Push text frame to the WebSocket connection asynchronously.
    
    Parameters:
    
    text - text to be sent
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
  - pushText
```
io.netty.channel.ChannelFuture pushText(String text,
                                        boolean finalFrame)
```
    Push text frame to the WebSocket connection asynchronously.
    
    Parameters:
    
    text - text to be sent
    
    finalFrame - true if sending final frame
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
  - pushBinary
```
io.netty.channel.ChannelFuture pushBinary(ByteBuffer data)
```
    Push binary frame to the WebSocket connection asynchronously.
    
    Parameters:
    
    data - binary data to be sent
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
  - pushBinary
```
io.netty.channel.ChannelFuture pushBinary(ByteBuffer data,
                                          boolean finalFrame)
```
    Push binary frame to the WebSocket connection asynchronously.
    
    Parameters:
    
    data - binary data to be sent
    
    finalFrame - true if sending final frame
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
  - ping
```
io.netty.channel.ChannelFuture ping(ByteBuffer data)
```
    Ping remote endpoint asynchronously.
    
    Parameters:
    
    data - data to be sent with ping frame
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
  - pong
```
io.netty.channel.ChannelFuture pong(ByteBuffer data)
```
    Send pong to remote endpoint asynchronously.
    
    Parameters:
    
    data - data to be sent with ping frame
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
  - initiateConnectionClosure
```
io.netty.channel.ChannelFuture initiateConnectionClosure(int statusCode,
                                                         String reason)
```
    Initiates connection closure. ChannelFuture will complete operation successfully if and only if it receives back a echoed close WebSocket frame from the remote endpoint with the same status code as was written. Also ChannelFuture will not reach operationComplete state until it receives a close WebSocket frame from the remote endpoint. If user does not need to wait for the echoed back WebSocket frame from the remote endpoint, user need to handle it separately.
    
    Parameters:
    
    statusCode - Status code to indicate the reason of closure
    
    reason - Reason to close the connection
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
    
    See Also:
    
    WebSocket Protocol
  - initiateConnectionClosure
```
io.netty.channel.ChannelFuture initiateConnectionClosure()
```
    Initiates connection closure. ChannelFuture will complete operation successfully if and only if it receives back a echoed close WebSocket frame from the remote endpoint with the same status code as was written. Also ChannelFuture will not reach operationComplete state until it receives a close WebSocket frame from the remote endpoint. If user does not need to wait for the echoed back WebSocket frame from the remote endpoint, user need to handle it separately.
    
    Returns:
    
    the future to represent the completion of asynchronous frame sending
  - finishConnectionClosure
```
io.netty.channel.ChannelFuture finishConnectionClosure(int statusCode,
                                                       String reason)
```
    Finish the connection closure if a close frame has been received without this connection sending a close frame.
    
    Parameters:
    
    statusCode - Status code to indicate the reason of closure
    
    reason - Reason to close the connection
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
    
    See Also:
    
    WebSocket Protocol
  - finishConnectionClosure
```
io.netty.channel.ChannelFuture finishConnectionClosure()
```
    Finish the connection closure if a close frame has been received without this connection sending a close frame.
    
    Returns:
    
    the future to represent the completion of asynchronous frame sending
  - terminateConnection
```
io.netty.channel.ChannelFuture terminateConnection()
```
    Terminate connection without close frame.
    
    Returns:
    
    Future to represent the completion of closure asynchronously
  - terminateConnection
```
io.netty.channel.ChannelFuture terminateConnection(int statusCode,
                                                   String reason)
```
    Send a close frame and close the connection without waiting for a response.
    
    Parameters:
    
    statusCode - Status code to indicate the reason of closure
    
    reason - Reason to close the connection
    
    Returns:
    
    Future to represent the completion of asynchronous frame sending
    
    See Also:
    
    WebSocket Protocol

Interface WebSocketConnection

Method Summary

Method Detail

getChannelId

isOpen

isSecure

getHost

getPort

getNegotiatedSubProtocol

readNextFrame

startReadingFrames

stopReadingFrames

pushText

pushText

pushBinary

pushBinary

ping

pong

initiateConnectionClosure

initiateConnectionClosure

finishConnectionClosure

finishConnectionClosure

terminateConnection

terminateConnection