io.reactivex.netty.protocol.http.ws

Class WebSocketConnection

java.lang.Object

io.reactivex.netty.protocol.http.ws.WebSocketConnection

public final class WebSocketConnection
extends java.lang.Object

A WebSocket connection which is used to read/write WebSocketFrames.

Constructor Summary

Constructors

Constructor and Description
WebSocketConnection(io.reactivex.netty.channel.Connection<io.netty.handler.codec.http.websocketx.WebSocketFrame,io.netty.handler.codec.http.websocketx.WebSocketFrame> delegate)

Method Summary

Modifier and Type	Method and Description
rx.Observable<java.lang.Void>	close() Flushes any pending writes and closes the connection.
rx.Observable<java.lang.Void>	close(boolean flush) Closes this channel after flushing all pending writes.
rx.Observable<java.lang.Void>	closeListener() Returns an Observable that completes when this connection is closed.
void	closeNow() Closes the connection immediately.
void	flush() Flushes all writes, if any, before calling the flush.
rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame>	getInput() Returns the input stream for this connection, until a CloseWebSocketFrame is received.
rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame>	getInput(boolean untilCloseFrame) Returns the input stream for this connection.
rx.Observable<java.lang.Void>	write(rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame> msgs) Writes a stream of frames on this connection.
rx.Observable<java.lang.Void>	write(rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame> msgs, rx.functions.Func1<io.netty.handler.codec.http.websocketx.WebSocketFrame,java.lang.Boolean> flushSelector) On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, everytime, flushSelector returns true .
rx.Observable<java.lang.Void>	writeAndFlushOnEach(rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, on every write.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketConnection

public WebSocketConnection(io.reactivex.netty.channel.Connection<io.netty.handler.codec.http.websocketx.WebSocketFrame,io.netty.handler.codec.http.websocketx.WebSocketFrame> delegate)

Method Detail

getInput

public rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame> getInput()

Returns the input stream for this connection, until a CloseWebSocketFrame is received. The terminal CloseWebSocketFrame is included in the returned stream.

Returns:

The input stream for this connection.

getInput

@Beta
public rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame> getInput(boolean untilCloseFrame)

Returns the input stream for this connection. If untilCloseFrame is true then the returned stream completes after receiving (and emitting) a CloseWebSocketFrame, otherwise, it completes with an error when the underlying channel is closed.

Returns:

The input stream for this connection.

write

public rx.Observable<java.lang.Void> write(rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame> msgs)

Writes a stream of frames on this connection. The writes are flushed on completion of the stream, if other flush strategies are required, one must use write(Observable, Func1) or writeAndFlushOnEach(Observable)

Parameters:

msgs - Stream of frames to write.

Returns:

Observable representing the result of this write. Every subscription to this Observable will replay the write on the channel.

write

public rx.Observable<java.lang.Void> write(rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame> msgs,
                                           rx.functions.Func1<io.netty.handler.codec.http.websocketx.WebSocketFrame,java.lang.Boolean> flushSelector)

On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, everytime, flushSelector returns true . Any writes issued before subscribing, will also be flushed. However, the returned Observable will not capture the result of those writes, i.e. if the other writes, fail and this write does not, the returned Observable will not fail.

Parameters:

msgs - Message stream to write.

flushSelector - A Func1 which is invoked for every item emitted from msgs. Channel is flushed, iff this function returns, true.

Returns:

An Observable representing the result of this write. Every subscription to this Observable will write the passed messages and flush all pending writes, when the flushSelector returns true

writeAndFlushOnEach

public rx.Observable<java.lang.Void> writeAndFlushOnEach(rx.Observable<io.netty.handler.codec.http.websocketx.WebSocketFrame> msgs)

On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, on every write. Any writes issued before subscribing, will also be flushed. However, the returned Observable will not capture the result of those writes, i.e. if the other writes, fail and this write does not, the returned Observable will not fail.

Parameters:

msgs - Message stream to write.

Returns:

An Observable representing the result of this write. Every subscription to this Observable will write the passed messages and flush all pending writes, on every write.

flush

public void flush()

Flushes all writes, if any, before calling the flush.

close

public rx.Observable<java.lang.Void> close()

Flushes any pending writes and closes the connection. Same as calling close(true)

Returns:

Observable representing the result of close.

close

public rx.Observable<java.lang.Void> close(boolean flush)

Closes this channel after flushing all pending writes.

Returns:

Observable representing the result of close and flush.

closeListener

public rx.Observable<java.lang.Void> closeListener()

Returns an Observable that completes when this connection is closed.

Returns:

An Observable that completes when this connection is closed.

closeNow

public void closeNow()

Closes the connection immediately. Same as calling close() and subscribing to the returned Observable