org.springframework.web.socket.sockjs.client

Class XhrClientSockJsSession

java.lang.Object

org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

org.springframework.web.socket.sockjs.client.XhrClientSockJsSession

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, WebSocketSession

public class XhrClientSockJsSession
extends AbstractClientSockJsSession

An extension of AbstractClientSockJsSession for use with HTTP transports simulating a WebSocket session.

Since:

4.1

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private int	binaryMessageSizeLimit
private HttpHeaders	headers
private HttpHeaders	sendHeaders
private java.net.URI	sendUrl
private int	textMessageSizeLimit
private XhrTransport	transport

Fields inherited from class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

logger

Constructor Summary

Constructors

Constructor and Description
XhrClientSockJsSession(TransportRequest request, WebSocketHandler handler, XhrTransport transport, SettableListenableFuture<WebSocketSession> connectFuture)

Method Summary

Modifier and Type	Method and Description
protected void	disconnect(CloseStatus status)
java.lang.String	getAcceptedProtocol() Return the negotiated sub-protocol or null if none was specified or negotiated successfully.
int	getBinaryMessageSizeLimit() Get the configured maximum size for an incoming binary message.
java.util.List<WebSocketExtension>	getExtensions() Return the negotiated extensions or null if none was specified or negotiated successfully.
HttpHeaders	getHeaders()
java.net.InetSocketAddress	getLocalAddress() Return the address on which the request was received.
java.net.InetSocketAddress	getRemoteAddress() Return the address of the remote client.
int	getTextMessageSizeLimit() Get the configured maximum size for an incoming text message.
protected void	sendInternal(TextMessage message)
void	setBinaryMessageSizeLimit(int messageSizeLimit) Configure the maximum size for an incoming binary message.
void	setTextMessageSizeLimit(int messageSizeLimit) Configure the maximum size for an incoming text message.

Methods inherited from class org.springframework.web.socket.sockjs.client.AbstractClientSockJsSession

afterTransportClosed, close, close, closeInternal, getAttributes, getHandshakeHeaders, getId, getMessageCodec, getPrincipal, getTimeoutTask, getUri, getWebSocketHandler, handleFrame, handleTransportError, isDisconnected, isOpen, sendMessage, toString

Methods inherited from class java.lang.Object

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

Field Detail

transport

private final XhrTransport transport

headers

private HttpHeaders headers

sendHeaders

private HttpHeaders sendHeaders

sendUrl

private final java.net.URI sendUrl

textMessageSizeLimit

private int textMessageSizeLimit

binaryMessageSizeLimit

private int binaryMessageSizeLimit

Constructor Detail

XhrClientSockJsSession

public XhrClientSockJsSession(TransportRequest request,
                              WebSocketHandler handler,
                              XhrTransport transport,
                              SettableListenableFuture<WebSocketSession> connectFuture)

Method Detail

getHeaders

public HttpHeaders getHeaders()

getLocalAddress

public java.net.InetSocketAddress getLocalAddress()

Description copied from interface: WebSocketSession

Return the address on which the request was received.

getRemoteAddress

public java.net.InetSocketAddress getRemoteAddress()

Description copied from interface: WebSocketSession

Return the address of the remote client.

getAcceptedProtocol

public java.lang.String getAcceptedProtocol()

Description copied from interface: WebSocketSession

Return the negotiated sub-protocol or null if none was specified or negotiated successfully.

setTextMessageSizeLimit

public void setTextMessageSizeLimit(int messageSizeLimit)

Description copied from interface: WebSocketSession

Configure the maximum size for an incoming text message.

getTextMessageSizeLimit

public int getTextMessageSizeLimit()

Description copied from interface: WebSocketSession

Get the configured maximum size for an incoming text message.

setBinaryMessageSizeLimit

public void setBinaryMessageSizeLimit(int messageSizeLimit)

Description copied from interface: WebSocketSession

Configure the maximum size for an incoming binary message.

getBinaryMessageSizeLimit

public int getBinaryMessageSizeLimit()

Description copied from interface: WebSocketSession

Get the configured maximum size for an incoming binary message.

getExtensions

public java.util.List<WebSocketExtension> getExtensions()

Description copied from interface: WebSocketSession

Return the negotiated extensions or null if none was specified or negotiated successfully.

sendInternal

protected void sendInternal(TextMessage message)

Specified by:

sendInternal in class AbstractClientSockJsSession

disconnect

protected void disconnect(CloseStatus status)

Specified by:

disconnect in class AbstractClientSockJsSession