MessageConsumer (Vert.x Stack

java.lang.Object
- io.vertx.rxjava.core.eventbus.MessageConsumer<T>

All Implemented Interfaces:

ReadStream<Message<T>>, StreamBase
```
public class MessageConsumer<T>
extends Object
implements ReadStream<Message<T>>
```
An event bus consumer object representing a stream of message to an EventBus address that can be read from.
The EventBus.consumer(java.lang.String) or EventBus.localConsumer(java.lang.String) creates a new consumer, the returned consumer is not yet registered against the event bus. Registration is effective after the handler(io.vertx.core.Handler<io.vertx.rxjava.core.eventbus.Message<T>>) method is invoked.
The consumer is unregistered from the event bus using the unregister() method or by calling the handler(io.vertx.core.Handler<io.vertx.rxjava.core.eventbus.Message<T>>) with a null value..
NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields
Modifier and Type Field and Description

static io.vertx.lang.rx.TypeArg<MessageConsumer> __TYPE_ARG

io.vertx.lang.rx.TypeArg<T> __typeArg_0

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<MessageConsumer>`	`__TYPE_ARG`
`io.vertx.lang.rx.TypeArg<T>`	`__typeArg_0`

Constructor Summary

Constructors
Constructor and Description

MessageConsumer(MessageConsumer delegate)

MessageConsumer(Object delegate, io.vertx.lang.rx.TypeArg<T> typeArg_0)

Constructors
Constructor and Description
`MessageConsumer(MessageConsumer delegate)`
`MessageConsumer(Object delegate, io.vertx.lang.rx.TypeArg<T> typeArg_0)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`address()`
`ReadStream<T>`	`bodyStream()`
`void`	`completionHandler(Handler<AsyncResult<Void>> completionHandler)` Optional method which can be called to indicate when the registration has been propagated across the cluster.
`Observable<Void>`	`completionHandlerObservable()` Deprecated. use `rxCompletionHandler()` instead
`MessageConsumer<T>`	`endHandler(Handler<Void> endHandler)` Set an end handler.
`boolean`	`equals(Object o)`
`MessageConsumer<T>`	`exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the read stream.
`MessageConsumer<T>`	`fetch(long amount)` Fetch the specified `amount` of elements.
`MessageConsumer`	`getDelegate()`
`int`	`getMaxBufferedMessages()`
`MessageConsumer<T>`	`handler(Handler<Message<T>> handler)` Set a data handler.
`int`	`hashCode()`
`boolean`	`isRegistered()`
`static <T> MessageConsumer<T>`	`newInstance(MessageConsumer arg)`
`static <T> MessageConsumer<T>`	`newInstance(MessageConsumer arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)`
`MessageConsumer<T>`	`pause()` Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
`Pipe<Message<T>>`	`pipe()` Pause this stream and return a to transfer the elements of this stream to a destination .
`void`	`pipeTo(WriteStream<Message<T>> dst)` Like `ReadStream.pipeTo(io.vertx.rxjava.core.streams.WriteStream<T>)` but with no completion handler.
`void`	`pipeTo(WriteStream<Message<T>> dst, Handler<AsyncResult<Void>> handler)` Pipe this `ReadStream` to the `WriteStream`.
`Observable<Void>`	`pipeToObservable(WriteStream<Message<T>> dst)` Deprecated. use `rxPipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.eventbus.Message<T>>)` instead
`MessageConsumer<T>`	`resume()` Resume reading, and sets the buffer in `flowing` mode.
`Single<Void>`	`rxCompletionHandler()` Optional method which can be called to indicate when the registration has been propagated across the cluster.
`Single<Void>`	`rxPipeTo(WriteStream<Message<T>> dst)` Pipe this `ReadStream` to the `WriteStream`.
`Single<Void>`	`rxUnregister()` Unregisters the handler which created this registration
`MessageConsumer<T>`	`setMaxBufferedMessages(int maxBufferedMessages)` Set the number of messages this registration will buffer when this stream is paused.
`Observable<Message<T>>`	`toObservable()`
`String`	`toString()`
`void`	`unregister()` Unregisters the handler which created this registration
`void`	`unregister(Handler<AsyncResult<Void>> completionHandler)` Unregisters the handler which created this registration
`Observable<Void>`	`unregisterObservable()` Deprecated. use `rxUnregister()` instead

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.rxjava.core.streams.ReadStream
newInstance, newInstance

Methods inherited from interface io.vertx.rxjava.core.streams.StreamBase
newInstance

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<MessageConsumer> __TYPE_ARG
```
  - __typeArg_0
```
public final io.vertx.lang.rx.TypeArg<T> __typeArg_0
```
- Constructor Detail
  - MessageConsumer
```
public MessageConsumer(MessageConsumer delegate)
```
  - MessageConsumer
```
public MessageConsumer(Object delegate,
                       io.vertx.lang.rx.TypeArg<T> typeArg_0)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDelegate
```
public MessageConsumer getDelegate()
```
    Specified by:
    
    getDelegate in interface ReadStream<Message<T>>
    
    Specified by:
    
    getDelegate in interface StreamBase
  - toObservable
```
public Observable<Message<T>> toObservable()
```
    Specified by:
    
    toObservable in interface ReadStream<Message<T>>
  - pipe
```
public Pipe<Message<T>> pipe()
```
    Pause this stream and return a to transfer the elements of this stream to a destination .
    The stream will be resumed when the pipe will be wired to a WriteStream.
    
    Specified by:
    
    pipe in interface ReadStream<Message<T>>
    
    Returns:
    
    a pipe
  - pipeTo
```
public void pipeTo(WriteStream<Message<T>> dst)
```
    Like ReadStream.pipeTo(io.vertx.rxjava.core.streams.WriteStream<T>) but with no completion handler.
    
    Specified by:
    
    pipeTo in interface ReadStream<Message<T>>
    
    Parameters:
    
    dst -
  - pipeTo
```
public void pipeTo(WriteStream<Message<T>> dst,
                   Handler<AsyncResult<Void>> handler)
```
    Pipe this ReadStream to the WriteStream.
    Elements emitted by this stream will be written to the write stream until this stream ends or fails.
    Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.
    
    Specified by:
    
    pipeTo in interface ReadStream<Message<T>>
    
    Parameters:
    
    dst - the destination write stream
    
    handler -
  - pipeToObservable
```
@Deprecated
public Observable<Void> pipeToObservable(WriteStream<Message<T>> dst)
```
    Deprecated. use rxPipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.eventbus.Message<T>>) instead
    
    Pipe this ReadStream to the WriteStream.
    Elements emitted by this stream will be written to the write stream until this stream ends or fails.
    Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.
    
    Parameters:
    
    dst - the destination write stream
    
    Returns:
  - rxPipeTo
```
public Single<Void> rxPipeTo(WriteStream<Message<T>> dst)
```
    Pipe this ReadStream to the WriteStream.
    Elements emitted by this stream will be written to the write stream until this stream ends or fails.
    Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.
    
    Parameters:
    
    dst - the destination write stream
    
    Returns:
  - exceptionHandler
```
public MessageConsumer<T> exceptionHandler(Handler<Throwable> handler)
```
    Description copied from interface: ReadStream
    
    Set an exception handler on the read stream.
    
    Specified by:
    
    exceptionHandler in interface ReadStream<Message<T>>
    
    Specified by:
    
    exceptionHandler in interface StreamBase
    
    Parameters:
    
    handler - the exception handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - handler
```
public MessageConsumer<T> handler(Handler<Message<T>> handler)
```
    Description copied from interface: ReadStream
    
    Set a data handler. As data is read, the handler will be called with the data.
    
    Specified by:
    
    handler in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - pause
```
public MessageConsumer<T> pause()
```
    Description copied from interface: ReadStream
    
    Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
    While it's paused, no data will be sent to the data handler.
    
    Specified by:
    
    pause in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - resume
```
public MessageConsumer<T> resume()
```
    Description copied from interface: ReadStream
    
    Resume reading, and sets the buffer in flowing mode.
    If the ReadStream has been paused, reading will recommence on it.
    
    Specified by:
    
    resume in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - fetch
```
public MessageConsumer<T> fetch(long amount)
```
    Description copied from interface: ReadStream
    
    Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
    
    Specified by:
    
    fetch in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - endHandler
```
public MessageConsumer<T> endHandler(Handler<Void> endHandler)
```
    Description copied from interface: ReadStream
    
    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
    
    Specified by:
    
    endHandler in interface ReadStream<Message<T>>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - bodyStream
```
public ReadStream<T> bodyStream()
```
    Returns:
    
    a read stream for the body of the message stream.
  - isRegistered
```
public boolean isRegistered()
```
    Returns:
    
    true if the current consumer is registered
  - address
```
public String address()
```
    Returns:
    
    The address the handler was registered with.
  - setMaxBufferedMessages
```
public MessageConsumer<T> setMaxBufferedMessages(int maxBufferedMessages)
```
    Set the number of messages this registration will buffer when this stream is paused. The default value is 1000.
    When a new value is set, buffered messages may be discarded to reach the new value. The most recent messages will be kept.
    
    Parameters:
    
    maxBufferedMessages - the maximum number of messages that can be buffered
    
    Returns:
    
    this registration
  - getMaxBufferedMessages
```
public int getMaxBufferedMessages()
```
    Returns:
    
    the maximum number of messages that can be buffered when this stream is paused
  - completionHandler
```
public void completionHandler(Handler<AsyncResult<Void>> completionHandler)
```
    Optional method which can be called to indicate when the registration has been propagated across the cluster.
    
    Parameters:
    
    completionHandler - the completion handler
  - completionHandlerObservable
```
@Deprecated
public Observable<Void> completionHandlerObservable()
```
    Deprecated. use rxCompletionHandler() instead
    
    Optional method which can be called to indicate when the registration has been propagated across the cluster.
    
    Returns:
  - rxCompletionHandler
```
public Single<Void> rxCompletionHandler()
```
    Optional method which can be called to indicate when the registration has been propagated across the cluster.
    
    Returns:
  - unregister
```
public void unregister()
```
    Unregisters the handler which created this registration
  - unregister
```
public void unregister(Handler<AsyncResult<Void>> completionHandler)
```
    Unregisters the handler which created this registration
    
    Parameters:
    
    completionHandler - the handler called when the unregister is done. For example in a cluster when all nodes of the event bus have been unregistered.
  - unregisterObservable
```
@Deprecated
public Observable<Void> unregisterObservable()
```
    Deprecated. use rxUnregister() instead
    
    Unregisters the handler which created this registration
    
    Returns:
  - rxUnregister
```
public Single<Void> rxUnregister()
```
    Unregisters the handler which created this registration
    
    Returns:
  - newInstance
```
public static <T> MessageConsumer<T> newInstance(MessageConsumer arg)
```
  - newInstance
```
public static <T> MessageConsumer<T> newInstance(MessageConsumer arg,
                                                 io.vertx.lang.rx.TypeArg<T> __typeArg_T)
```

Class MessageConsumer<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.rxjava.core.streams.ReadStream

Methods inherited from interface io.vertx.rxjava.core.streams.StreamBase

Field Detail

__TYPE_ARG

__typeArg_0

Constructor Detail

MessageConsumer

MessageConsumer

Method Detail

toString

equals

hashCode

getDelegate

toObservable

pipe

pipeTo

pipeTo

pipeToObservable

rxPipeTo

exceptionHandler

handler

pause

resume

fetch

endHandler

bodyStream

isRegistered

address

setMaxBufferedMessages

getMaxBufferedMessages

completionHandler

completionHandlerObservable

rxCompletionHandler

unregister

unregister

unregisterObservable

rxUnregister

newInstance

newInstance