Package org.apache.qpid.protonj2.client

Interface StreamReceiverMessage

All Superinterfaces:

AdvancedMessage<InputStream>, Message<InputStream>

All Known Implementing Classes:

ClientStreamReceiverMessage

public interface StreamReceiverMessage
extends AdvancedMessage<InputStream>

A specialized Message type that represents a streamed delivery possibly spanning many incoming Transfer frames from the remote peer. It is possible for various calls in this StreamReceiverMessage to block while awaiting the receipt of sufficient bytes to provide the result.

Method Summary

Modifier and Type	Method	Description
boolean	aborted()	Check if the StreamDelivery that was assigned to this StreamReceiverMessage has been marked as aborted by the remote.
boolean	completed()	Check if the StreamDelivery that was assigned to this StreamReceiverMessage has been marked as complete by the remote.
StreamDelivery	delivery()
StreamReceiver	receiver()

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

addBodySection, annotations, annotations, applicationProperties, applicationProperties, bodySections, bodySections, clearBodySections, encode, encode, footer, footer, forEachBodySection, header, header, messageFormat, messageFormat, properties, properties

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

absoluteExpiryTime, absoluteExpiryTime, annotation, annotation, body, body, contentEncoding, contentEncoding, contentType, contentType, correlationId, correlationId, creationTime, creationTime, deliveryCount, deliveryCount, durable, durable, firstAcquirer, firstAcquirer, footer, footer, forEachAnnotation, forEachFooter, forEachProperty, groupId, groupId, groupSequence, groupSequence, hasAnnotation, hasAnnotations, hasFooter, hasFooters, hasProperties, hasProperty, messageId, messageId, priority, priority, property, property, removeAnnotation, removeFooter, removeProperty, replyTo, replyTo, replyToGroupId, replyToGroupId, subject, subject, timeToLive, timeToLive, to, to, toAdvancedMessage, userId, userId

Method Details

delivery

StreamDelivery delivery()

Returns:

the StreamDelivery that is associated with the life-cycle of this StreamReceiverMessage

receiver

StreamReceiver receiver()

Returns:

the StreamReceiver that this context was create under.

aborted

boolean aborted()

Check if the StreamDelivery that was assigned to this StreamReceiverMessage has been marked as aborted by the remote.

Returns:

true if this context has been marked as aborted previously.

completed

boolean completed()

Check if the StreamDelivery that was assigned to this StreamReceiverMessage has been marked as complete by the remote.

Returns:

true if this context has been marked as being the complete.