Package org.apache.qpid.protonj2.client
Interface StreamSender
-
- All Superinterfaces:
java.lang.AutoCloseable
,Sender
- All Known Implementing Classes:
ClientStreamSender
public interface StreamSender extends Sender
Sending link implementation that allows sending of large message payload data in multiple transfers to reduce memory overhead of large message sends.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StreamSenderMessage
beginMessage()
Creates and returns a newStreamSenderMessage
that can be used by the caller to perform streaming sends of large message payload data.StreamSenderMessage
beginMessage(java.util.Map<java.lang.String,java.lang.Object> deliveryAnnotations)
Creates and returns a newStreamSenderMessage
that can be used by the caller to perform streaming sends of large message payload data.-
Methods inherited from interface org.apache.qpid.protonj2.client.Sender
address, client, close, close, closeAsync, closeAsync, connection, desiredCapabilities, detach, detach, detachAsync, detachAsync, offeredCapabilities, openFuture, properties, send, send, session, source, target, trySend, trySend
-
-
-
-
Method Detail
-
beginMessage
StreamSenderMessage beginMessage() throws ClientException
Creates and returns a newStreamSenderMessage
that can be used by the caller to perform streaming sends of large message payload data.- Returns:
- a new
StreamSenderMessage
that can be used to stream message data to the remote. - Throws:
ClientException
- if an error occurs while initiating a new streaming send message.
-
beginMessage
StreamSenderMessage beginMessage(java.util.Map<java.lang.String,java.lang.Object> deliveryAnnotations) throws ClientException
Creates and returns a newStreamSenderMessage
that can be used by the caller to perform streaming sends of large message payload data.- Parameters:
deliveryAnnotations
- the delivery annotations that should be included in the sentStreamSenderMessage
.- Returns:
- a new
StreamSenderMessage
that can be used to stream message data to the remote. - Throws:
ClientException
- if an error occurs while initiating a new streaming send message.
-
-