RabbitMQConsumer (Vert.x Stack

java.lang.Object
- io.vertx.rxjava.rabbitmq.RabbitMQConsumer

All Implemented Interfaces:

ReadStream<RabbitMQMessage>, StreamBase
```
public class RabbitMQConsumer
extends Object
implements ReadStream<RabbitMQMessage>
```
A stream of messages from a rabbitmq queue.
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<RabbitMQConsumer> __TYPE_ARG

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

Constructor Summary

Constructors
Constructor and Description

RabbitMQConsumer(Object delegate)

RabbitMQConsumer(RabbitMQConsumer delegate)

Constructors
Constructor and Description
`RabbitMQConsumer(Object delegate)`
`RabbitMQConsumer(RabbitMQConsumer delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cancel()` Stop message consumption from a queue.
`void`	`cancel(Handler<AsyncResult<Void>> cancelResult)` Stop message consumption from a queue.
`Observable<Void>`	`cancelObservable()` Deprecated. use `rxCancel()` instead
`String`	`consumerTag()`
`RabbitMQConsumer`	`endHandler(Handler<Void> endHandler)` Set an end handler.
`boolean`	`equals(Object o)`
`RabbitMQConsumer`	`exceptionHandler(Handler<Throwable> exceptionHandler)` Set an exception handler on the read stream.
`ReadStream<RabbitMQMessage>`	`fetch(long amount)` Fetch the specified `amount` of elements.
`RabbitMQConsumer`	`getDelegate()`
`RabbitMQConsumer`	`handler(Handler<RabbitMQMessage> messageArrived)` Set a message handler.
`int`	`hashCode()`
`boolean`	`isPaused()`
`static RabbitMQConsumer`	`newInstance(RabbitMQConsumer arg)`
`RabbitMQConsumer`	`pause()` Pause the stream of incoming messages from queue.
`Pipe<RabbitMQMessage>`	`pipe()` Pause this stream and return a to transfer the elements of this stream to a destination .
`void`	`pipeTo(WriteStream<RabbitMQMessage> dst)` Like `ReadStream.pipeTo(io.vertx.rxjava.core.streams.WriteStream<T>)` but with no completion handler.
`void`	`pipeTo(WriteStream<RabbitMQMessage> dst, Handler<AsyncResult<Void>> handler)` Pipe this `ReadStream` to the `WriteStream`.
`Observable<Void>`	`pipeToObservable(WriteStream<RabbitMQMessage> dst)` Deprecated. use `rxPipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.rabbitmq.RabbitMQMessage>)` instead
`RabbitMQConsumer`	`resume()` Resume reading from a queue.
`Single<Void>`	`rxCancel()` Stop message consumption from a queue.
`Single<Void>`	`rxPipeTo(WriteStream<RabbitMQMessage> dst)` Pipe this `ReadStream` to the `WriteStream`.
`Observable<RabbitMQMessage>`	`toObservable()`
`String`	`toString()`

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<RabbitMQConsumer> __TYPE_ARG
```
- Constructor Detail
  - RabbitMQConsumer
```
public RabbitMQConsumer(RabbitMQConsumer delegate)
```
  - RabbitMQConsumer
```
public RabbitMQConsumer(Object delegate)
```
- 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 RabbitMQConsumer getDelegate()
```
    Specified by:
    
    getDelegate in interface ReadStream<RabbitMQMessage>
    
    Specified by:
    
    getDelegate in interface StreamBase
  - toObservable
```
public Observable<RabbitMQMessage> toObservable()
```
    Specified by:
    
    toObservable in interface ReadStream<RabbitMQMessage>
  - fetch
```
public ReadStream<RabbitMQMessage> fetch(long amount)
```
    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<RabbitMQMessage>
    
    Parameters:
    
    amount -
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - pipe
```
public Pipe<RabbitMQMessage> 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<RabbitMQMessage>
    
    Returns:
    
    a pipe
  - pipeTo
```
public void pipeTo(WriteStream<RabbitMQMessage> dst)
```
    Like ReadStream.pipeTo(io.vertx.rxjava.core.streams.WriteStream<T>) but with no completion handler.
    
    Specified by:
    
    pipeTo in interface ReadStream<RabbitMQMessage>
    
    Parameters:
    
    dst -
  - pipeTo
```
public void pipeTo(WriteStream<RabbitMQMessage> 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<RabbitMQMessage>
    
    Parameters:
    
    dst - the destination write stream
    
    handler -
  - pipeToObservable
```
@Deprecated
public Observable<Void> pipeToObservable(WriteStream<RabbitMQMessage> dst)
```
    Deprecated. use rxPipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.rabbitmq.RabbitMQMessage>) 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<RabbitMQMessage> 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 RabbitMQConsumer exceptionHandler(Handler<Throwable> exceptionHandler)
```
    Set an exception handler on the read stream.
    
    Specified by:
    
    exceptionHandler in interface ReadStream<RabbitMQMessage>
    
    Specified by:
    
    exceptionHandler in interface StreamBase
    
    Parameters:
    
    exceptionHandler - the exception handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - handler
```
public RabbitMQConsumer handler(Handler<RabbitMQMessage> messageArrived)
```
    Set a message handler. As message appear in a queue, the handler will be called with the message.
    
    Specified by:
    
    handler in interface ReadStream<RabbitMQMessage>
    
    Parameters:
    
    messageArrived -
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - pause
```
public RabbitMQConsumer pause()
```
    Pause the stream of incoming messages from queue.
    The messages will continue to arrive, but they will be stored in a internal queue. If the queue size would exceed the limit provided by , then incoming messages will be discarded.
    
    Specified by:
    
    pause in interface ReadStream<RabbitMQMessage>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - resume
```
public RabbitMQConsumer resume()
```
    Resume reading from a queue. Flushes internal queue.
    
    Specified by:
    
    resume in interface ReadStream<RabbitMQMessage>
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - endHandler
```
public RabbitMQConsumer endHandler(Handler<Void> endHandler)
```
    Set an end handler. Once the stream has canceled successfully, the handler will be called.
    
    Specified by:
    
    endHandler in interface ReadStream<RabbitMQMessage>
    
    Parameters:
    
    endHandler -
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - consumerTag
```
public String consumerTag()
```
    Returns:
    
    a consumer tag
  - cancel
```
public void cancel()
```
    Stop message consumption from a queue.
    The operation is asynchronous. When consumption will be stopped, you can by notified via endHandler(io.vertx.core.Handler<java.lang.Void>)
  - cancel
```
public void cancel(Handler<AsyncResult<Void>> cancelResult)
```
    Stop message consumption from a queue.
    The operation is asynchronous. When consumption will be stopped, you can by notified via endHandler(io.vertx.core.Handler<java.lang.Void>)
    
    Parameters:
    
    cancelResult - contains information about operation status: success/fail.
  - cancelObservable
```
@Deprecated
public Observable<Void> cancelObservable()
```
    Deprecated. use rxCancel() instead
    
    Stop message consumption from a queue.
    The operation is asynchronous. When consumption will be stopped, you can by notified via endHandler(io.vertx.core.Handler<java.lang.Void>)
    
    Returns:
  - rxCancel
```
public Single<Void> rxCancel()
```
    Stop message consumption from a queue.
    The operation is asynchronous. When consumption will be stopped, you can by notified via endHandler(io.vertx.core.Handler<java.lang.Void>)
    
    Returns:
  - isPaused
```
public boolean isPaused()
```
    Returns:
    
    is the stream paused?
  - newInstance
```
public static RabbitMQConsumer newInstance(RabbitMQConsumer arg)
```

Class RabbitMQConsumer

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

Constructor Detail

RabbitMQConsumer

RabbitMQConsumer

Method Detail

toString

equals

hashCode

getDelegate

toObservable

fetch

pipe

pipeTo

pipeTo

pipeToObservable

rxPipeTo

exceptionHandler

handler

pause

resume

endHandler

consumerTag

cancel

cancel

cancelObservable

rxCancel

isPaused

newInstance