io.vertx.amqp

Interface AmqpSender

All Superinterfaces:

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

public interface AmqpSender
extends io.vertx.core.streams.WriteStream<AmqpMessage>

AMQP Sender interface used to send messages.

Method Summary

Modifier and Type	Method and Description
String	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 sender.
AmqpConnection	connection() Gets the connection having created the sender.
AmqpSender	exceptionHandler(io.vertx.core.Handler<Throwable> handler)
long	remainingCredits()
AmqpSender	send(AmqpMessage message) Sends an AMQP message.
io.vertx.core.Future<Void>	sendWithAck(AmqpMessage message) Like sendWithAck(AmqpMessage, Handler) but returns a Future of the asynchronous result
AmqpSender	sendWithAck(AmqpMessage message, io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> acknowledgementHandler) Sends an AMQP message and waits for an acknowledgement.
AmqpSender	setWriteQueueMaxSize(int maxSize)
ProtonSender	unwrap()

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

drainHandler, end, end, end, end, write, write, writeQueueFull

Method Detail

exceptionHandler

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

Specified by:

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

Specified by:

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

setWriteQueueMaxSize

AmqpSender setWriteQueueMaxSize(int maxSize)

Specified by:

setWriteQueueMaxSize in interface io.vertx.core.streams.WriteStream<AmqpMessage>

send

AmqpSender send(AmqpMessage message)

Sends an AMQP message. The destination the configured sender address or the address configured in the message.

Parameters:

message - the message, must not be null

Returns:

the current sender

sendWithAck

AmqpSender sendWithAck(AmqpMessage message,
                       io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> acknowledgementHandler)

Sends an AMQP message and waits for an acknowledgement. The acknowledgement handler is called with an AsyncResult marked as failed if the message has been rejected or re-routed. If the message has been accepted, the handler is called with a success.

Parameters:

message - the message, must not be null

acknowledgementHandler - the acknowledgement handler, must not be null

Returns:

the current sender

sendWithAck

io.vertx.core.Future<Void> sendWithAck(AmqpMessage message)

Like sendWithAck(AmqpMessage, Handler) but returns a Future of the asynchronous result

close

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

Closes the sender.

Parameters:

handler - called when the sender has been closed, must not be null

close

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

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

address

String address()

Returns:

the configured address.

connection

AmqpConnection connection()

Gets the connection having created the sender. Cannot be null

Returns:

the connection having created the sender.

remainingCredits

long remainingCredits()

Returns:

the remaining credit, 0 is none.

unwrap

ProtonSender unwrap()

Returns:

the underlying ProtonSender.