Package com.microsoft.azure.proton.transport.ws

Interface WebSocket

All Known Implementing Classes:

WebSocketImpl

public interface WebSocket

Provides interface for WebSocket.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebSocket.WebSocketFrameReadState	States for the web socket when reading from the underlying buffer.
static class	WebSocket.WebSocketState	States that the web socket can be in.

Method Summary

Modifier and Type	Method	Description
void	configure(String host, String path, String query, int port, String protocol, Map<String,String> additionalHeaders, WebSocketHandler webSocketHandler)	Configure WebSocket connection.
Boolean	getEnabled()	Access if WebSocket enabled .
ByteBuffer	getInputBuffer()	Access the input buffer (read only).
ByteBuffer	getOutputBuffer()	Access the output buffer (read only).
ByteBuffer	getPingBuffer()	Access the ping buffer (read only).
WebSocket.WebSocketState	getState()	Access the current state of the layer.
WebSocketHandler	getWebSocketHandler()	Access the handler for WebSocket functions.
ByteBuffer	getWsInputBuffer()	Access the web socket input buffer (read only).
WebSocketHandler.WebsocketTuple	unwrapBuffer(ByteBuffer buffer)	Remove WebSocket frame from the given buffer.
void	wrapBuffer(ByteBuffer srcBuffer, ByteBuffer dstBuffer)	Add WebSocket frame to send the given buffer.

Method Detail

configure

void configure(String host,
               String path,
               String query,
               int port,
               String protocol,
               Map<String,String> additionalHeaders,
               WebSocketHandler webSocketHandler)

Configure WebSocket connection.

Parameters:

host - the hots name

path - the resource path

query - the query

port - the port

protocol - the base protocol

additionalHeaders - the Map of additional headers

webSocketHandler - the web socket handler

wrapBuffer

void wrapBuffer(ByteBuffer srcBuffer,
                ByteBuffer dstBuffer)

Add WebSocket frame to send the given buffer.

Parameters:

srcBuffer - the source buffer

dstBuffer - the destination buffer

unwrapBuffer

WebSocketHandler.WebsocketTuple unwrapBuffer(ByteBuffer buffer)

Remove WebSocket frame from the given buffer.

Parameters:

buffer - the buffer to unwrap

Returns:

The payload of the given WebSocket frame.

getWebSocketHandler

WebSocketHandler getWebSocketHandler()

Access the handler for WebSocket functions.

Returns:

The WebSocket handler class.

getState

WebSocket.WebSocketState getState()

Access the current state of the layer.

Returns:

The state of the WebSocket layer.

getEnabled

Boolean getEnabled()

Access if WebSocket enabled .

Returns:

True if WebSocket enabled otherwise false.

getOutputBuffer

ByteBuffer getOutputBuffer()

Access the output buffer (read only).

Returns:

The current output buffer.

getInputBuffer

ByteBuffer getInputBuffer()

Access the input buffer (read only).

Returns:

The current input buffer.

getPingBuffer

ByteBuffer getPingBuffer()

Access the ping buffer (read only).

Returns:

The ping input buffer.

getWsInputBuffer

ByteBuffer getWsInputBuffer()

Access the web socket input buffer (read only).

Returns:

The wsInputBuffer input buffer.