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

Class WebSocketImpl

java.lang.Object

com.microsoft.azure.proton.transport.ws.impl.WebSocketImpl

All Implemented Interfaces:

WebSocket, org.apache.qpid.proton.engine.impl.TransportLayer

public class WebSocketImpl
extends java.lang.Object
implements WebSocket, org.apache.qpid.proton.engine.impl.TransportLayer

Implementation for WebSocket.

Nested Class Summary

Nested classes/interfaces inherited from interface com.microsoft.azure.proton.transport.ws.WebSocket

WebSocket.WebSocketFrameReadState, WebSocket.WebSocketState

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Boolean	isWebSocketEnabled

Constructor Summary

Constructors

Constructor	Description
WebSocketImpl()	Create WebSocket transport layer - which, after configuring using the configure(String, String, String, int, String, Map, WebSocketHandler) API is ready for layering in qpid-proton-j transport layers, using TransportInternal.addTransportLayer(TransportLayer) API.
WebSocketImpl(int customMaxFrameSize)	Create WebSocket transport layer - which, after configuring using the configure(String, String, String, int, String, Map, WebSocketHandler) API is ready for layering in qpid-proton-j transport layers, using TransportInternal.addTransportLayer(TransportLayer) API.

Method Summary

Modifier and Type	Method	Description
void	configure(java.lang.String host, java.lang.String path, java.lang.String query, int port, java.lang.String protocol, java.util.Map<java.lang.String,java.lang.String> additionalHeaders, WebSocketHandler webSocketHandler)	Configure WebSocket connection.
java.lang.Boolean	getEnabled()	Access if WebSocket enabled .
java.nio.ByteBuffer	getInputBuffer()	Access the input buffer (read only).
java.nio.ByteBuffer	getOutputBuffer()	Access the output buffer (read only).
java.nio.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.
java.nio.ByteBuffer	getWsInputBuffer()	Access the web socket input buffer (read only).
java.lang.String	toString()
WebSocketHandler.WebsocketTuple	unwrapBuffer(java.nio.ByteBuffer buffer)	Remove WebSocket frame from the given buffer.
org.apache.qpid.proton.engine.impl.TransportWrapper	wrap(org.apache.qpid.proton.engine.impl.TransportInput input, org.apache.qpid.proton.engine.impl.TransportOutput output)
void	wrapBuffer(java.nio.ByteBuffer srcBuffer, java.nio.ByteBuffer dstBuffer)	Add WebSocket frame to send the given buffer.
protected void	writeClose()
protected void	writePong()
protected void	writeUpgradeRequest()

Methods inherited from class java.lang.Object

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

Field Detail

isWebSocketEnabled

protected java.lang.Boolean isWebSocketEnabled

Constructor Detail

WebSocketImpl

public WebSocketImpl()

Create WebSocket transport layer - which, after configuring using the configure(String, String, String, int, String, Map, WebSocketHandler) API is ready for layering in qpid-proton-j transport layers, using TransportInternal.addTransportLayer(TransportLayer) API.

WebSocketImpl

public WebSocketImpl(int customMaxFrameSize)

Create WebSocket transport layer - which, after configuring using the configure(String, String, String, int, String, Map, WebSocketHandler) API is ready for layering in qpid-proton-j transport layers, using TransportInternal.addTransportLayer(TransportLayer) API.

Parameters:

customMaxFrameSize - the maximum frame size that this layer will buffer for

Method Detail

wrap

public org.apache.qpid.proton.engine.impl.TransportWrapper wrap(org.apache.qpid.proton.engine.impl.TransportInput input,
                                                                org.apache.qpid.proton.engine.impl.TransportOutput output)

Specified by:

wrap in interface org.apache.qpid.proton.engine.impl.TransportLayer

configure

public void configure(java.lang.String host,
                      java.lang.String path,
                      java.lang.String query,
                      int port,
                      java.lang.String protocol,
                      java.util.Map<java.lang.String,java.lang.String> additionalHeaders,
                      WebSocketHandler webSocketHandler)

Description copied from interface: WebSocket

Configure WebSocket connection.

Specified by:

configure in interface WebSocket

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

public void wrapBuffer(java.nio.ByteBuffer srcBuffer,
                       java.nio.ByteBuffer dstBuffer)

Description copied from interface: WebSocket

Add WebSocket frame to send the given buffer.

Specified by:

wrapBuffer in interface WebSocket

Parameters:

srcBuffer - the source buffer

dstBuffer - the destination buffer

unwrapBuffer

public WebSocketHandler.WebsocketTuple unwrapBuffer(java.nio.ByteBuffer buffer)

Description copied from interface: WebSocket

Remove WebSocket frame from the given buffer.

Specified by:

unwrapBuffer in interface WebSocket

Parameters:

buffer - the buffer to unwrap

Returns:

The payload of the given WebSocket frame.

getState

public WebSocket.WebSocketState getState()

Description copied from interface: WebSocket

Access the current state of the layer.

Specified by:

getState in interface WebSocket

Returns:

The state of the WebSocket layer.

getOutputBuffer

public java.nio.ByteBuffer getOutputBuffer()

Description copied from interface: WebSocket

Access the output buffer (read only).

Specified by:

getOutputBuffer in interface WebSocket

Returns:

The current output buffer.

getInputBuffer

public java.nio.ByteBuffer getInputBuffer()

Description copied from interface: WebSocket

Access the input buffer (read only).

Specified by:

getInputBuffer in interface WebSocket

Returns:

The current input buffer.

getPingBuffer

public java.nio.ByteBuffer getPingBuffer()

Description copied from interface: WebSocket

Access the ping buffer (read only).

Specified by:

getPingBuffer in interface WebSocket

Returns:

The ping input buffer.

getWsInputBuffer

public java.nio.ByteBuffer getWsInputBuffer()

Description copied from interface: WebSocket

Access the web socket input buffer (read only).

Specified by:

getWsInputBuffer in interface WebSocket

Returns:

The wsInputBuffer input buffer.

getEnabled

public java.lang.Boolean getEnabled()

Description copied from interface: WebSocket

Access if WebSocket enabled .

Specified by:

getEnabled in interface WebSocket

Returns:

True if WebSocket enabled otherwise false.

getWebSocketHandler

public WebSocketHandler getWebSocketHandler()

Description copied from interface: WebSocket

Access the handler for WebSocket functions.

Specified by:

getWebSocketHandler in interface WebSocket

Returns:

The WebSocket handler class.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeUpgradeRequest

protected void writeUpgradeRequest()

writePong

protected void writePong()

writeClose

protected void writeClose()