Package io.vertx.rxjava.amqp

Class AmqpSender

java.lang.Object

io.vertx.rxjava.amqp.AmqpSender

All Implemented Interfaces:

StreamBase, WriteStream<AmqpMessage>

public class AmqpSender
extends Object
implements WriteStream<AmqpMessage>

AMQP Sender interface used to send messages.

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	Description
static TypeArg<AmqpSender>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
AmqpSender(AmqpSender delegate)
AmqpSender(Object delegate)

Method Summary

Modifier and Type	Method	Description
String	address()
void	close()	Closes the sender.
void	close(Handler<AsyncResult<Void>> handler)	Closes the sender.
AmqpConnection	connection()	Gets the connection having created the sender.
WriteStream<AmqpMessage>	drainHandler(Handler<Void> handler)	Set a drain handler on the stream.
void	end()	Same as WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
void	end(Handler<AsyncResult<Void>> handler)	Same as WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
void	end(AmqpMessage data)	Same as but with an handler called when the operation completes
void	end(AmqpMessage data, Handler<AsyncResult<Void>> handler)	Same as but with an handler called when the operation completes
boolean	equals(Object o)
AmqpSender	exceptionHandler(Handler<Throwable> handler)	Set an exception handler on the write stream.
AmqpSender	getDelegate()
int	hashCode()
static AmqpSender	newInstance(AmqpSender arg)
long	remainingCredits()
rx.Single<Void>	rxClose()	Closes the sender.
rx.Single<Void>	rxEnd()	Same as WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
rx.Single<Void>	rxEnd(AmqpMessage data)	Same as but with an handler called when the operation completes
rx.Single<Void>	rxSendWithAck(AmqpMessage message)	Sends an AMQP message and waits for an acknowledgement.
rx.Single<Void>	rxWrite(AmqpMessage data)	Same as but with an handler called when the operation completes
AmqpSender	send(AmqpMessage message)	Sends an AMQP message.
AmqpSender	sendWithAck(AmqpMessage message)	Sends an AMQP message and waits for an acknowledgement.
AmqpSender	sendWithAck(AmqpMessage message, Handler<AsyncResult<Void>> acknowledgementHandler)	Sends an AMQP message and waits for an acknowledgement.
AmqpSender	setWriteQueueMaxSize(int maxSize)	Set the maximum size of the write queue to maxSize.
String	toString()
WriteStreamSubscriber<AmqpMessage>	toSubscriber()
io.vertx.proton.ProtonSender	unwrap()
void	write(AmqpMessage data)	Same as but with an handler called when the operation completes
void	write(AmqpMessage data, Handler<AsyncResult<Void>> handler)	Same as but with an handler called when the operation completes
boolean	writeQueueFull()	This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<AmqpSender> __TYPE_ARG

Constructor Detail

AmqpSender

public AmqpSender(AmqpSender delegate)

AmqpSender

public AmqpSender(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 AmqpSender getDelegate()

Specified by:

getDelegate in interface StreamBase

Specified by:

getDelegate in interface WriteStream<AmqpMessage>

toSubscriber

public WriteStreamSubscriber<AmqpMessage> toSubscriber()

write

public void write(AmqpMessage data,
                  Handler<AsyncResult<Void>> handler)

Same as but with an handler called when the operation completes

Specified by:

write in interface WriteStream<AmqpMessage>

Parameters:

data -

handler -

write

public void write(AmqpMessage data)

Same as but with an handler called when the operation completes

Specified by:

write in interface WriteStream<AmqpMessage>

Parameters:

data -

rxWrite

public rx.Single<Void> rxWrite(AmqpMessage data)

Same as but with an handler called when the operation completes

Specified by:

rxWrite in interface WriteStream<AmqpMessage>

Parameters:

data -

Returns:

end

public void end(Handler<AsyncResult<Void>> handler)

Same as WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

end in interface WriteStream<AmqpMessage>

Parameters:

handler -

end

public void end()

Same as WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

end in interface WriteStream<AmqpMessage>

rxEnd

public rx.Single<Void> rxEnd()

Same as WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxEnd in interface WriteStream<AmqpMessage>

Returns:

end

public void end(AmqpMessage data,
                Handler<AsyncResult<Void>> handler)

Same as but with an handler called when the operation completes

Specified by:

end in interface WriteStream<AmqpMessage>

Parameters:

data -

handler -

end

public void end(AmqpMessage data)

Same as but with an handler called when the operation completes

Specified by:

end in interface WriteStream<AmqpMessage>

Parameters:

data -

rxEnd

public rx.Single<Void> rxEnd(AmqpMessage data)

Same as but with an handler called when the operation completes

Specified by:

rxEnd in interface WriteStream<AmqpMessage>

Parameters:

data -

Returns:

writeQueueFull

public boolean writeQueueFull()

This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)

Specified by:

writeQueueFull in interface WriteStream<AmqpMessage>

Returns:

true if write queue is full

drainHandler

public WriteStream<AmqpMessage> drainHandler(Handler<Void> handler)

Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See for an example of this being used.

The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to maxSize / 2.

Specified by:

drainHandler in interface WriteStream<AmqpMessage>

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

exceptionHandler

public AmqpSender exceptionHandler(Handler<Throwable> handler)

Description copied from interface: WriteStream

Set an exception handler on the write stream.

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<AmqpMessage>

Parameters:

handler - the exception handler

Returns:

a reference to this, so the API can be used fluently

setWriteQueueMaxSize

public AmqpSender setWriteQueueMaxSize(int maxSize)

Description copied from interface: WriteStream

Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pipe to provide flow control.

The value is defined by the implementation of the stream, e.g in bytes for a NetSocket, etc...

Specified by:

setWriteQueueMaxSize in interface WriteStream<AmqpMessage>

Parameters:

maxSize - the max size of the write stream

Returns:

a reference to this, so the API can be used fluently

send

public 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

public AmqpSender sendWithAck(AmqpMessage message,
                              Handler<AsyncResult<Void>> acknowledgementHandler)

Sends an AMQP message and waits for an acknowledgement. The acknowledgement handler is called with an 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

public AmqpSender sendWithAck(AmqpMessage message)

Sends an AMQP message and waits for an acknowledgement. The acknowledgement handler is called with an 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

Returns:

the current sender

rxSendWithAck

public rx.Single<Void> rxSendWithAck(AmqpMessage message)

Sends an AMQP message and waits for an acknowledgement. The acknowledgement handler is called with an 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

Returns:

the current sender

close

public void close(Handler<AsyncResult<Void>> handler)

Closes the sender.

Parameters:

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

close

public void close()

Closes the sender.

rxClose

public rx.Single<Void> rxClose()

Closes the sender.

Returns:

address

public String address()

Returns:

the configured address.

connection

public AmqpConnection connection()

Gets the connection having created the sender. Cannot be null

Returns:

the connection having created the sender.

remainingCredits

public long remainingCredits()

Returns:

the remaining credit, 0 is none.

unwrap

public io.vertx.proton.ProtonSender unwrap()

Returns:

the underlying ProtonSender.

newInstance

public static AmqpSender newInstance(AmqpSender arg)