Package org.apache.qpid.protonj2.client

Interface StreamSender

All Superinterfaces:

AutoCloseable, Link<StreamSender>

All Known Implementing Classes:

ClientStreamSender

public interface StreamSender
extends Link<StreamSender>

Sending link implementation that allows sending of large message payload data in multiple transfers to reduce memory overhead of large message sends.

Method Summary

Modifier and Type	Method	Description
StreamSenderMessage	beginMessage()	Creates and returns a new StreamSenderMessage that can be used by the caller to perform streaming sends of large message payload data.
StreamSenderMessage	beginMessage(Map<String,Object> deliveryAnnotations)	Creates and returns a new StreamSenderMessage that can be used by the caller to perform streaming sends of large message payload data.
StreamTracker	send(Message<?> message)	Send the given message immediately if there is credit available or blocks if the link has not yet been granted credit or there is a streaming send ongoing.
StreamTracker	send(Message<?> message, Map<String,Object> deliveryAnnotations)	Send the given message immediately if there is credit available or blocks if the link has not yet been granted credit or there is a streaming send ongoing.
StreamTracker	trySend(Message<?> message)	Send the given message if credit is available or returns null if no credit has been granted to the link at the time of the send attempt or a streaming send is ongoing.
StreamTracker	trySend(Message<?> message, Map<String,Object> deliveryAnnotations)	Send the given message if credit is available or returns null if no credit has been granted to the link at the time of the send attempt.

Methods inherited from interface org.apache.qpid.protonj2.client.Link

address, client, close, close, closeAsync, closeAsync, connection, desiredCapabilities, detach, detach, detachAsync, detachAsync, offeredCapabilities, openFuture, properties, session, source, target

Method Detail

send

StreamTracker send(Message<?> message)
            throws ClientException

Send the given message immediately if there is credit available or blocks if the link has not yet been granted credit or there is a streaming send ongoing.

Upon successfully sending the message the methods returns a Tracker that can be used to await settlement of the message from the remote. If the sender has been configured to send the message pre-settled then the resulting Tracker will immediately report the message as remotely settlement and accepted.

Parameters:

message - the Message to send.

Returns:

the Tracker for the message delivery

Throws:

ClientException - if an error occurs while initiating the send operation.

send

StreamTracker send(Message<?> message,
                   Map<String,Object> deliveryAnnotations)
            throws ClientException

Send the given message immediately if there is credit available or blocks if the link has not yet been granted credit or there is a streaming send ongoing. The provided delivery annotations are encoded along with the message, the annotations can be passed repeatedly to send calls if sending the same delivery annotations with each message.

Upon successfully sending the message the methods returns a Tracker that can be used to await settlement of the message from the remote. If the sender has been configured to send the message pre-settled then the resulting Tracker will immediately report the message as remotely settlement and accepted.

Parameters:

message - the Message to send.

deliveryAnnotations - the delivery annotations that should be included in the sent Message.

Returns:

the StreamTracker for the message delivery

Throws:

ClientException - if an error occurs while initiating the send operation.

trySend

StreamTracker trySend(Message<?> message)
               throws ClientException

Send the given message if credit is available or returns null if no credit has been granted to the link at the time of the send attempt or a streaming send is ongoing.

Upon successfully sending the message the methods returns a Tracker that can be used to await settlement of the message from the remote. If the sender has been configured to send the message pre-settled then the resulting Tracker will immediately report the message as remotely settlement and accepted.

Parameters:

message - the Message to send if credit is available.

Returns:

the StreamTracker for the message delivery or null if no credit for sending.

Throws:

ClientException - if an error occurs while initiating the send operation.

trySend

StreamTracker trySend(Message<?> message,
                      Map<String,Object> deliveryAnnotations)
               throws ClientException

Send the given message if credit is available or returns null if no credit has been granted to the link at the time of the send attempt. The provided delivery annotations are encoded along with the message, the annotations can be passed repeatedly to send calls if sending the same delivery annotations with each message.

Upon successfully sending the message the methods returns a Tracker that can be used to await settlement of the message from the remote. If the sender has been configured to send the message pre-settled then the resulting Tracker will immediately report the message as remotely settlement and accepted.

Parameters:

message - the Message to send if credit is available.

deliveryAnnotations - the delivery annotations that should be included in the sent Message.

Returns:

the StreamTracker for the message delivery or null if no credit for sending.

Throws:

ClientException - if an error occurs while initiating the send operation.

beginMessage

StreamSenderMessage beginMessage()
                          throws ClientException

Creates and returns a new StreamSenderMessage 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(Map<String,Object> deliveryAnnotations)
                          throws ClientException

Creates and returns a new StreamSenderMessage that can be used by the caller to perform streaming sends of large message payload data. The provided delivery annotations are encoded along with the message, the annotations can be passed repeatedly to send calls if sending the same delivery annotations with each message.

Parameters:

deliveryAnnotations - the delivery annotations that should be included in the sent StreamSenderMessage.

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.