Class AmqpSender
- java.lang.Object
-
- io.vertx.reactivex.amqp.AmqpSender
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,StreamBase,WriteStream<AmqpMessage>
public class AmqpSender extends Object implements io.vertx.lang.rx.RxDelegate, WriteStream<AmqpMessage>
AMQP Sender interface used to send messages.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<AmqpSender>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description AmqpSender(AmqpSender delegate)AmqpSender(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringaddress()Future<Void>close()Closes the sender.AmqpConnectionconnection()Gets the connection having created the sender.WriteStream<AmqpMessage>drainHandler(Handler<Void> handler)Set a drain handler on the stream.Future<Void>end()Ends the stream.Future<Void>end(AmqpMessage data)Same asWriteStream.end()but writes some data to the stream before ending.booleanequals(Object o)AmqpSenderexceptionHandler(Handler<Throwable> handler)Set an exception handler on the write stream.AmqpSendergetDelegate()inthashCode()static AmqpSendernewInstance(AmqpSender arg)longremainingCredits()CompletablerxClose()Closes the sender.CompletablerxEnd()Ends the stream.CompletablerxEnd(AmqpMessage data)Same asWriteStream.end()but writes some data to the stream before ending.CompletablerxSendWithAck(AmqpMessage message)Sends an AMQP message and waits for an acknowledgement.CompletablerxWrite(AmqpMessage data)Write some data to the stream.AmqpSendersend(AmqpMessage message)Sends an AMQP message.Future<Void>sendWithAck(AmqpMessage message)Sends an AMQP message and waits for an acknowledgement.AmqpSendersetWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.WriteStreamObserver<AmqpMessage>toObserver()StringtoString()WriteStreamSubscriber<AmqpMessage>toSubscriber()io.vertx.proton.ProtonSenderunwrap()Future<Void>write(AmqpMessage data)Write some data to the stream.booleanwriteQueueFull()This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<AmqpSender> __TYPE_ARG
-
-
Constructor Detail
-
AmqpSender
public AmqpSender(AmqpSender delegate)
-
AmqpSender
public AmqpSender(Object delegate)
-
-
Method Detail
-
getDelegate
public AmqpSender getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase- Specified by:
getDelegatein interfaceWriteStream<AmqpMessage>
-
toObserver
public WriteStreamObserver<AmqpMessage> toObserver()
- Specified by:
toObserverin interfaceWriteStream<AmqpMessage>
-
toSubscriber
public WriteStreamSubscriber<AmqpMessage> toSubscriber()
- Specified by:
toSubscriberin interfaceWriteStream<AmqpMessage>
-
write
public Future<Void> write(AmqpMessage data)
Write some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using a .When the
datais moved from the queue to the actual medium, the returned will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
writein interfaceWriteStream<AmqpMessage>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
rxWrite
public Completable rxWrite(AmqpMessage data)
Write some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using a .When the
datais moved from the queue to the actual medium, the returned will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
rxWritein interfaceWriteStream<AmqpMessage>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
end
public Future<Void> end()
Ends the stream.Once the stream has ended, it cannot be used any more.
- Specified by:
endin interfaceWriteStream<AmqpMessage>- Returns:
- a future completed with the result
-
rxEnd
public Completable rxEnd()
Ends the stream.Once the stream has ended, it cannot be used any more.
- Specified by:
rxEndin interfaceWriteStream<AmqpMessage>- Returns:
- a future completed with the result
-
end
public Future<Void> end(AmqpMessage data)
Same asWriteStream.end()but writes some data to the stream before ending.- Specified by:
endin interfaceWriteStream<AmqpMessage>- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
rxEnd
public Completable rxEnd(AmqpMessage data)
Same asWriteStream.end()but writes some data to the stream before ending.- Specified by:
rxEndin interfaceWriteStream<AmqpMessage>- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
writeQueueFull
public boolean writeQueueFull()
This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)- Specified by:
writeQueueFullin interfaceWriteStream<AmqpMessage>- Returns:
trueif 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:
drainHandlerin interfaceWriteStream<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:WriteStreamSet an exception handler on the write stream.- Specified by:
exceptionHandlerin interfaceStreamBase- Specified by:
exceptionHandlerin interfaceWriteStream<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:WriteStreamSet the maximum size of the write queue tomaxSize. You will still be able to write to the stream even if there is more thanmaxSizeitems in the write queue. This is used as an indicator by classes such asPipeto provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket, etc...- Specified by:
setWriteQueueMaxSizein interfaceWriteStream<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 benull- Returns:
- the current sender
-
sendWithAck
public Future<Void> sendWithAck(AmqpMessage message)
Sends an AMQP message and waits for an acknowledgement. It returns a future 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 benull- Returns:
- a future notified with the acknowledgement
-
rxSendWithAck
public Completable rxSendWithAck(AmqpMessage message)
Sends an AMQP message and waits for an acknowledgement. It returns a future 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 benull- Returns:
- a future notified with the acknowledgement
-
close
public Future<Void> close()
Closes the sender.- Returns:
- a future notified when the sender has been closed
-
rxClose
public Completable rxClose()
Closes the sender.- Returns:
- a future notified when the sender has been closed
-
address
public String address()
- Returns:
- the configured address.
-
connection
public AmqpConnection connection()
Gets the connection having created the sender. Cannot benull- 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)
-
-