org.springframework.web.socket.sockjs.client

Interface TransportRequest

All Known Implementing Classes:

DefaultTransportRequest

public interface TransportRequest

Represents a request to connect to a SockJS service using a specific Transport. A single SockJS request however may require falling back and therefore multiple TransportRequest instances.

Since:

4.1

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
void	addTimeoutTask(java.lang.Runnable runnable) Register a timeout cleanup task to invoke if the SockJS session is not fully established within the calculated retransmission timeout period.
HttpHeaders	getHandshakeHeaders() Return the headers to send with the connect request.
SockJsMessageCodec	getMessageCodec() Return the message codec to use for encoding SockJS messages.
SockJsUrlInfo	getSockJsUrlInfo() Return information about the SockJS URL including server and session id..
java.net.URI	getTransportUrl() Return the transport URL for the given transport.
java.security.Principal	getUser() Return the user associated with the request, if any.

Method Detail

getSockJsUrlInfo

SockJsUrlInfo getSockJsUrlInfo()

Return information about the SockJS URL including server and session id..

getHandshakeHeaders

HttpHeaders getHandshakeHeaders()

Return the headers to send with the connect request.

getTransportUrl

java.net.URI getTransportUrl()

Return the transport URL for the given transport. For an XhrTransport this is the URL for receiving messages.

getUser

java.security.Principal getUser()

Return the user associated with the request, if any.

getMessageCodec

SockJsMessageCodec getMessageCodec()

Return the message codec to use for encoding SockJS messages.

addTimeoutTask

void addTimeoutTask(java.lang.Runnable runnable)

Register a timeout cleanup task to invoke if the SockJS session is not fully established within the calculated retransmission timeout period.