io.vertx.amqp

Interface AmqpReceiver

All Superinterfaces:

io.vertx.core.streams.ReadStream<AmqpMessage>, io.vertx.core.streams.StreamBase

public interface AmqpReceiver
extends io.vertx.core.streams.ReadStream<AmqpMessage>

Interface used to consume AMQP message as a stream of message. Back pressure is implemented using AMQP credits.

Method Summary

Modifier and Type	Method and Description
String	address() The listened address.
io.vertx.core.Future<Void>	close() Like close(Handler) but returns a Future of the asynchronous result
void	close(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler) Closes the receiver.
AmqpConnection	connection() Gets the connection having created the receiver.
AmqpReceiver	endHandler(io.vertx.core.Handler<Void> endHandler)
AmqpReceiver	exceptionHandler(io.vertx.core.Handler<Throwable> handler)
AmqpReceiver	fetch(long amount)
AmqpReceiver	handler(io.vertx.core.Handler<AmqpMessage> handler)
AmqpReceiver	pause()
AmqpReceiver	resume()
ProtonReceiver	unwrap()

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

collect, pipe, pipeTo, pipeTo

Method Detail

exceptionHandler

AmqpReceiver exceptionHandler(io.vertx.core.Handler<Throwable> handler)

Specified by:

exceptionHandler in interface io.vertx.core.streams.ReadStream<AmqpMessage>

Specified by:

exceptionHandler in interface io.vertx.core.streams.StreamBase

handler

AmqpReceiver handler(io.vertx.core.Handler<AmqpMessage> handler)

Specified by:

handler in interface io.vertx.core.streams.ReadStream<AmqpMessage>

pause

AmqpReceiver pause()

Specified by:

pause in interface io.vertx.core.streams.ReadStream<AmqpMessage>

resume

AmqpReceiver resume()

Specified by:

resume in interface io.vertx.core.streams.ReadStream<AmqpMessage>

fetch

AmqpReceiver fetch(long amount)

Specified by:

fetch in interface io.vertx.core.streams.ReadStream<AmqpMessage>

endHandler

AmqpReceiver endHandler(io.vertx.core.Handler<Void> endHandler)

Specified by:

endHandler in interface io.vertx.core.streams.ReadStream<AmqpMessage>

address

String address()

The listened address.

Returns:

the address, not null

close

void close(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)

Closes the receiver.

Parameters:

handler - handler called when the receiver has been closed, can be null

close

io.vertx.core.Future<Void> close()

Like close(Handler) but returns a Future of the asynchronous result

connection

AmqpConnection connection()

Gets the connection having created the receiver. Cannot be null

Returns:

the connection having created the receiver.

unwrap

ProtonReceiver unwrap()

Returns:

the underlying ProtonReceiver.