ChannelOperations (RxJava Javadoc 0.5.3)

Type Parameters:

W - Type of data that can be written on the associated channel.

All Known Implementing Classes:

Connection, ConnectionImpl, DefaultChannelOperations, PooledConnection
```
public interface ChannelOperations<W>
```
A list of user initiated operations that can be done on a channel.

Field Summary

Fields
Modifier and Type	Field and Description
`static rx.functions.Func1<byte[],java.lang.Boolean>`	`FLUSH_ON_EACH_BYTES` Flush selector that always returns true.
`static rx.functions.Func1<io.netty.channel.FileRegion,java.lang.Boolean>`	`FLUSH_ON_EACH_FILE_REGION` Flush selector that always returns true.
`static rx.functions.Func1<java.lang.String,java.lang.Boolean>`	`FLUSH_ON_EACH_STRING` Flush selector that always returns true.
`static io.netty.util.AttributeKey<java.lang.Boolean>`	`FLUSH_ONLY_ON_READ_COMPLETE`

Method Summary

All Methods Instance Methods Abstract Methods
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 any pending writes on this connection by calling `Channel.flush()`.
`<WW> ChannelOperations<WW>`	`transformWrite(AllocatingTransformer<WW,W> transformer)` Modifies the underneath channel to enable writing new type of objects that will be transformed using the passed `transformer`
`rx.Observable<java.lang.Void>`	`write(rx.Observable<W> msgs)` On subscription of the returned `Observable`, writes the passed message stream on the underneath channel.
`rx.Observable<java.lang.Void>`	`write(rx.Observable<W> msgs, rx.functions.Func1<W,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<W> msgs)` On subscription of the returned `Observable`, writes the passed message stream on the underneath channel and flushes the channel, on every write.
`rx.Observable<java.lang.Void>`	`writeBytes(rx.Observable<byte[]> msgs)` On subscription of the returned `Observable`, writes the passed message stream on the underneath channel.
`rx.Observable<java.lang.Void>`	`writeBytes(rx.Observable<byte[]> msgs, rx.functions.Func1<byte[],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>`	`writeBytesAndFlushOnEach(rx.Observable<byte[]> msgs)` On subscription of the returned `Observable`, writes the passed message stream on the underneath channel and flushes the channel, on every write.
`rx.Observable<java.lang.Void>`	`writeFileRegion(rx.Observable<io.netty.channel.FileRegion> msgs)` On subscription of the returned `Observable`, writes the passed message stream on the underneath channel.
`rx.Observable<java.lang.Void>`	`writeFileRegion(rx.Observable<io.netty.channel.FileRegion> msgs, rx.functions.Func1<io.netty.channel.FileRegion,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>`	`writeFileRegionAndFlushOnEach(rx.Observable<io.netty.channel.FileRegion> msgs)` On subscription of the returned `Observable`, writes the passed message stream on the underneath channel and flushes the channel, on every write.
`rx.Observable<java.lang.Void>`	`writeString(rx.Observable<java.lang.String> msgs)` On subscription of the returned `Observable`, writes the passed message stream on the underneath channel.
`rx.Observable<java.lang.Void>`	`writeString(rx.Observable<java.lang.String> msgs, rx.functions.Func1<java.lang.String,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>`	`writeStringAndFlushOnEach(rx.Observable<java.lang.String> msgs)` On subscription of the returned `Observable`, writes the passed message stream on the underneath channel and flushes the channel, on every write.

- Field Detail
  - FLUSH_ON_EACH_STRING
```
static final rx.functions.Func1<java.lang.String,java.lang.Boolean> FLUSH_ON_EACH_STRING
```
    Flush selector that always returns true.
  - FLUSH_ON_EACH_BYTES
```
static final rx.functions.Func1<byte[],java.lang.Boolean> FLUSH_ON_EACH_BYTES
```
    Flush selector that always returns true.
  - FLUSH_ON_EACH_FILE_REGION
```
static final rx.functions.Func1<io.netty.channel.FileRegion,java.lang.Boolean> FLUSH_ON_EACH_FILE_REGION
```
    Flush selector that always returns true.
  - FLUSH_ONLY_ON_READ_COMPLETE
```
static final io.netty.util.AttributeKey<java.lang.Boolean> FLUSH_ONLY_ON_READ_COMPLETE
```
- Method Detail
  - write
```
rx.Observable<java.lang.Void> write(rx.Observable<W> msgs)
```
    On subscription of the returned Observable, writes the passed message stream on the underneath channel.
    Flush.
    All writes will be flushed on completion of the passed Observable
    
    Parameters:
    
    msgs - Stream of messages to write.
    
    Returns:
    
    Observable representing the result of this write. Every subscription to this Observable will replay the write on the channel.
  - write
```
rx.Observable<java.lang.Void> write(rx.Observable<W> msgs,
                                    rx.functions.Func1<W,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
```
rx.Observable<java.lang.Void> writeAndFlushOnEach(rx.Observable<W> 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.
  - writeString
```
rx.Observable<java.lang.Void> writeString(rx.Observable<java.lang.String> msgs)
```
    On subscription of the returned Observable, writes the passed message stream on the underneath channel.
    Flush.
    All writes will be flushed on completion of the passed Observable
    
    Parameters:
    
    msgs - Stream of messages to write.
    
    Returns:
    
    Observable representing the result of this write. Every subscription to this Observable will replay the write on the channel.
  - writeString
```
rx.Observable<java.lang.Void> writeString(rx.Observable<java.lang.String> msgs,
                                          rx.functions.Func1<java.lang.String,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
  - writeStringAndFlushOnEach
```
rx.Observable<java.lang.Void> writeStringAndFlushOnEach(rx.Observable<java.lang.String> 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.
  - writeBytes
```
rx.Observable<java.lang.Void> writeBytes(rx.Observable<byte[]> msgs)
```
    On subscription of the returned Observable, writes the passed message stream on the underneath channel.
    Flush.
    All writes will be flushed on completion of the passed Observable
    
    Parameters:
    
    msgs - Stream of messages to write.
    
    Returns:
    
    Observable representing the result of this write. Every subscription to this Observable will replay the write on the channel.
  - writeBytes
```
rx.Observable<java.lang.Void> writeBytes(rx.Observable<byte[]> msgs,
                                         rx.functions.Func1<byte[],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
  - writeBytesAndFlushOnEach
```
rx.Observable<java.lang.Void> writeBytesAndFlushOnEach(rx.Observable<byte[]> 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.
  - writeFileRegion
```
rx.Observable<java.lang.Void> writeFileRegion(rx.Observable<io.netty.channel.FileRegion> msgs)
```
    On subscription of the returned Observable, writes the passed message stream on the underneath channel.
    Flush.
    All writes will be flushed on completion of the passed Observable
    
    Parameters:
    
    msgs - Stream of messages to write.
    
    Returns:
    
    Observable representing the result of this write. Every subscription to this Observable will replay the write on the channel.
  - writeFileRegion
```
rx.Observable<java.lang.Void> writeFileRegion(rx.Observable<io.netty.channel.FileRegion> msgs,
                                              rx.functions.Func1<io.netty.channel.FileRegion,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
  - writeFileRegionAndFlushOnEach
```
rx.Observable<java.lang.Void> writeFileRegionAndFlushOnEach(rx.Observable<io.netty.channel.FileRegion> 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.
  - transformWrite
```
<WW> ChannelOperations<WW> transformWrite(AllocatingTransformer<WW,W> transformer)
```
    Modifies the underneath channel to enable writing new type of objects that will be transformed using the passed transformer
    
    Type Parameters:
    
    WW - The target type of the transformer.
    
    Parameters:
    
    transformer - Transformer to transform objects written to the channel.
    
    Returns:
    
    A new instance of ChannelOperations that accepts the transformed type to write.
  - flush
```
void flush()
```
    Flushes any pending writes on this connection by calling Channel.flush(). This can be used for implementing any custom flusing strategies that otherwise can not be implemented by methods like write(Observable, Func1).
  - close
```
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
```
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.
  - closeNow
```
void closeNow()
```
    Closes the connection immediately. Same as calling close() and subscribing to the returned Observable
  - closeListener
```
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.

RxJava

Interface ChannelOperations<W>

Field Summary

Method Summary

Field Detail

FLUSH_ON_EACH_STRING

FLUSH_ON_EACH_BYTES

FLUSH_ON_EACH_FILE_REGION

FLUSH_ONLY_ON_READ_COMPLETE

Method Detail

write

Flush.

write

writeAndFlushOnEach

writeString

Flush.

writeString

writeStringAndFlushOnEach

writeBytes

Flush.

writeBytes

writeBytesAndFlushOnEach

writeFileRegion

Flush.

writeFileRegion

writeFileRegionAndFlushOnEach

transformWrite

flush

close

close

closeNow

closeListener