A stream of messages from a rabbitmq queue.
package |
Default |
---|
__construct()
cancel( $arg0 = null) : void
The operation is asynchronous. When consumption will be stopped, you can by notified via @see \io\vertx\jphp\rabbitmq\RabbitMQConsumer::endHandler cancel() Stop message consumption from a queue.
The operation is asynchronous. When consumption will be stopped, you can by notified via @see \io\vertx\jphp\rabbitmq\RabbitMQConsumer::endHandler param $cancelResult [callable] contains information about operation status: success/fail. cancel($cancelResult)
callable
consumerTag() : string
string
a consumer tag
endHandler( $arg0) : $this
callable
$this
a reference to this, so the API can be used fluently
exceptionHandler( $arg0) : $this
callable
$this
a reference to this, so the API can be used fluently
fetch( $arg0) : $this
integer
$this
a reference to this, so the API can be used fluently
handler( $arg0) : $this
callable
$this
a reference to this, so the API can be used fluently
isPaused() : boolean
boolean
is the stream paused?
pause() : $this
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.
$this
a reference to this, so the API can be used fluently
pipe() : \io\vertx\jphp\rabbitmq\Pipe<RabbitMQMessage>
The stream will be resumed when the pipe will be wired to a WriteStream
.
\io\vertx\jphp\rabbitmq\Pipe
a pipe
pipeTo( $arg0, $arg1 = null) : void
param $dst [WriteStream
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.
param $dst [WriteStream
WriteStream
callable
resume() : $this
$this
a reference to this, so the API can be used fluently