Package io.vertx.reactivex.amqp
Class AmqpSender
- java.lang.Object
-
- io.vertx.reactivex.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 theoriginal
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
All Methods Static Methods Instance Methods Concrete Methods 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 asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
end(Handler<AsyncResult<Void>> handler)
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
end(AmqpMessage data)
Same as but with anhandler
called when the operation completesvoid
end(AmqpMessage data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completesboolean
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()
io.reactivex.Completable
rxClose()
Closes the sender.io.reactivex.Completable
rxEnd()
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxEnd(AmqpMessage data)
Same as but with anhandler
called when the operation completesio.reactivex.Completable
rxSendWithAck(AmqpMessage message)
Sends an AMQP message and waits for an acknowledgement.io.reactivex.Completable
rxWrite(AmqpMessage data)
Same as but with anhandler
called when the operation completesAmqpSender
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 tomaxSize
.WriteStreamObserver<AmqpMessage>
toObserver()
String
toString()
WriteStreamSubscriber<AmqpMessage>
toSubscriber()
io.vertx.proton.ProtonSender
unwrap()
void
write(AmqpMessage data)
Same as but with anhandler
called when the operation completesvoid
write(AmqpMessage data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completesboolean
writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
-
-
-
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
-
getDelegate
public AmqpSender getDelegate()
- Specified by:
getDelegate
in interfaceStreamBase
- Specified by:
getDelegate
in interfaceWriteStream<AmqpMessage>
-
toObserver
public WriteStreamObserver<AmqpMessage> toObserver()
-
toSubscriber
public WriteStreamSubscriber<AmqpMessage> toSubscriber()
-
write
public void write(AmqpMessage data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Specified by:
write
in interfaceWriteStream<AmqpMessage>
- Parameters:
data
-handler
-
-
write
public void write(AmqpMessage data)
Same as but with anhandler
called when the operation completes- Specified by:
write
in interfaceWriteStream<AmqpMessage>
- Parameters:
data
-
-
rxWrite
public io.reactivex.Completable rxWrite(AmqpMessage data)
Same as but with anhandler
called when the operation completes- Specified by:
rxWrite
in interfaceWriteStream<AmqpMessage>
- Parameters:
data
-- Returns:
-
end
public void end(Handler<AsyncResult<Void>> handler)
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<AmqpMessage>
- Parameters:
handler
-
-
end
public void end()
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<AmqpMessage>
-
rxEnd
public io.reactivex.Completable rxEnd()
Same asWriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxEnd
in interfaceWriteStream<AmqpMessage>
- Returns:
-
end
public void end(AmqpMessage data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<AmqpMessage>
- Parameters:
data
-handler
-
-
end
public void end(AmqpMessage data)
Same as but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<AmqpMessage>
- Parameters:
data
-
-
rxEnd
public io.reactivex.Completable rxEnd(AmqpMessage data)
Same as but with anhandler
called when the operation completes- Specified by:
rxEnd
in interfaceWriteStream<AmqpMessage>
- Parameters:
data
-- Returns:
-
writeQueueFull
public boolean writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
- Specified by:
writeQueueFull
in interfaceWriteStream<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 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:WriteStream
Set an exception handler on the write stream.- Specified by:
exceptionHandler
in interfaceStreamBase
- Specified by:
exceptionHandler
in 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:WriteStream
Set the maximum size of the write queue tomaxSize
. You will still be able to write to the stream even if there is more thanmaxSize
items in the write queue. This is used as an indicator by classes such asPipe
to provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket
, etc...- Specified by:
setWriteQueueMaxSize
in 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 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 benull
acknowledgementHandler
- the acknowledgement handler, must not benull
- 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 benull
- Returns:
- the current sender
-
rxSendWithAck
public io.reactivex.Completable 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 benull
- 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 benull
-
close
public void close()
Closes the sender.
-
rxClose
public io.reactivex.Completable 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 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)
-
-