HTTP functionality for the Reactor Netty library 1.1.16 · reactor.netty.http.websocket.WebsocketInbound

Method Summary

Modifier and Type	Method and Description
public default WebsocketInbound	Returns: this inbound aggregateFrames() Turn this `WebsocketInbound` into aggregating mode which will only produce fully formed frame that have been received fragmented.
public default WebsocketInbound	Returns: this inbound aggregateFrames(int the maximum frame length maxContentLength) Turn this `WebsocketInbound` into aggregating mode which will only produce fully formed frame that have been received fragmented.
public HttpHeaders	Returns: the websocket remote headers sent during handshake headers() Returns the websocket remote headers sent during handshake.
public Mono<WebSocketCloseStatus>	receiveCloseStatus() Receive the close status code and reason if sent by the remote peer, or empty if the connection completes otherwise.
public default Flux<WebSocketFrame>	Returns: a `Flux` of `WebSocketFrame` formed frame content receiveFrames() Receive a `Flux` of `WebSocketFrame` formed frame content.
public String	Returns: the subprotocol, or null selectedSubprotocol() Returns the websocket subprotocol negotiated by the client and server during the websocket handshake, or null if none was requested.

Inherited from reactor.netty.NettyInbound:: receive receiveObject withConnection

Method Detail

aggregateFrames back to summary

aggregateFrames	back to summary
public default WebsocketInbound aggregateFrames() Turn this `WebsocketInbound` into aggregating mode which will only produce fully formed frame that have been received fragmented. Will aggregate up to 65,536 bytes per frame Returns:WebsocketInbound this inbound

public default WebsocketInbound aggregateFrames()

Turn this WebsocketInbound into aggregating mode which will only produce fully formed frame that have been received fragmented. Will aggregate up to 65,536 bytes per frame

Returns:WebsocketInbound: this inbound

aggregateFrames back to summary

aggregateFrames	back to summary
public default WebsocketInbound aggregateFrames(int maxContentLength) Turn this `WebsocketInbound` into aggregating mode which will only produce fully formed frame that have been received fragmented. Parameters maxContentLength:int the maximum frame length Returns:WebsocketInbound this inbound

public default WebsocketInbound aggregateFrames(int maxContentLength)

Turn this WebsocketInbound into aggregating mode which will only produce fully formed frame that have been received fragmented.

Parameters

maxContentLength:int: the maximum frame length

Returns:WebsocketInbound

this inbound

headers	back to summary
public HttpHeaders headers() Returns the websocket remote headers sent during handshake. Returns:HttpHeaders the websocket remote headers sent during handshake

headers

back to summary

public HttpHeaders headers()

Returns the websocket remote headers sent during handshake.

Returns:HttpHeaders: the websocket remote headers sent during handshake

receiveCloseStatus back to summary

receiveCloseStatus	back to summary
public Mono<WebSocketCloseStatus> receiveCloseStatus() Receive the close status code and reason if sent by the remote peer, or empty if the connection completes otherwise. Note Some close status codes are designated for use in applications expecting a status code to indicate that the connection was closed etc. They are not meant to be set as a status code in a Close control frame as such these status codes cannot be used with `reactor.netty.http.websocket.WebsocketOutbound#sendClose*` methods. Consider checking RFC 6455#section-7.4 for a complete list of the close status codes.

public Mono<WebSocketCloseStatus> receiveCloseStatus()

Receive the close status code and reason if sent by the remote peer, or empty if the connection completes otherwise.

Note

Some close status codes are designated for use in applications expecting a status code to indicate that the connection was closed etc. They are not meant to be set as a status code in a Close control frame as such these status codes cannot be used with reactor.netty.http.websocket.WebsocketOutbound#sendClose* methods. Consider checking RFC 6455#section-7.4 for a complete list of the close status codes.

receiveFrames back to summary

receiveFrames	back to summary
public default Flux<WebSocketFrame> receiveFrames() Receive a `Flux` of `WebSocketFrame` formed frame content. Returns:Flux<WebSocketFrame> a `Flux` of `WebSocketFrame` formed frame content

public default Flux<WebSocketFrame> receiveFrames()

Receive a Flux of WebSocketFrame formed frame content.

Returns:Flux<WebSocketFrame>: a Flux of WebSocketFrame formed frame content

selectedSubprotocol	back to summary
public String selectedSubprotocol() Returns the websocket subprotocol negotiated by the client and server during the websocket handshake, or null if none was requested. Returns:String the subprotocol, or null Annotations @Nullable

selectedSubprotocol

back to summary

public String selectedSubprotocol()

Returns the websocket subprotocol negotiated by the client and server during the websocket handshake, or null if none was requested.

Returns:String

the subprotocol, or null

Annotations

@Nullable

public Interface WebsocketInbound

Method Summary

Method Detail