Package org.dellroad.msrp

Class OutputChunks

java.lang.Object

org.dellroad.msrp.OutputChunks

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<MsrpRequest>

public class OutputChunks
extends Object
implements Closeable, Iterator<MsrpRequest>

Represents one outgoing MSRP message broken into multiple SEND MsrpRequest chunks.

Constructor Summary

Constructors

Constructor	Description
OutputChunks(MsrpUri localURI, MsrpUri remoteURI, InputStream input, long size, String contentType, Iterable<? extends Header> headers, ReportListener reportListener)	Constructor for a message with a body.
OutputChunks(MsrpUri localURI, MsrpUri remoteURI, Iterable<? extends Header> headers, ReportListener reportListener)	Constructor for a message with no body.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the InputStream associated with this instance.
long	getIdleTime()	Get how long this instance has been idle.
String	getMessageId()	Get the unique message ID for this message.
ReportListener	getReportListener()	Get the associated ReportListener, if any.
long	getSize()	Get the size of the message body, if known.
boolean	hasNext()
boolean	isAborted()	Determine whether this instance has been aborted.
MsrpRequest	next()
void	notifyFailure(Session session, Executor executor, Status status)	Notify about failure, if appropriate.
void	notifySuccess(Session session, Executor executor, ByteRange byteRange)	Notify about success, if appropriate.
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

OutputChunks

public OutputChunks(MsrpUri localURI,
                    MsrpUri remoteURI,
                    Iterable<? extends Header> headers,
                    ReportListener reportListener)

Constructor for a message with no body.

Parameters:

localURI - local MSRP URI

remoteURI - remote MSRP URI

headers - other headers (MIME and/or extension), or null for none

reportListener - success and/or failure listener, or null for none

Throws:

IllegalArgumentException - if localURI or remoteURI is null

OutputChunks

public OutputChunks(MsrpUri localURI,
                    MsrpUri remoteURI,
                    InputStream input,
                    long size,
                    String contentType,
                    Iterable<? extends Header> headers,
                    ReportListener reportListener)

Constructor for a message with a body.

Parameters:

localURI - local MSRP URI

remoteURI - remote MSRP URI

input - message content input, or null for no content

size - size of input, or -1 if unknown; if not -1 and input is longer than size, it will be truncated

contentType - content type

headers - other headers (MIME and/or extension), or null for none

reportListener - success and/or failure listener, or null for none

Throws:

IllegalArgumentException - if localURI or remoteURI is null

IllegalArgumentException - if input is null and size != -1 or contentType is not null

IllegalArgumentException - if input is not null and contentType is null

Method Detail

getMessageId

public String getMessageId()

Get the unique message ID for this message.

Returns:

message ID

getReportListener

public ReportListener getReportListener()

Get the associated ReportListener, if any.

Returns:

report listener

getSize

public long getSize()

Get the size of the message body, if known.

Returns:

message body size, or -1 if size was not specified and message has not been fully sent yet

isAborted

public boolean isAborted()

Determine whether this instance has been aborted.

Returns:

true if aborted, otherwise false

getIdleTime

public long getIdleTime()

Get how long this instance has been idle.

Returns:

idle time in milliseconds

notifySuccess

public void notifySuccess(Session session,
                          Executor executor,
                          ByteRange byteRange)

Notify about success, if appropriate.

Parameters:

session - session on which the message was transmitted

executor - executor used to issue notification

byteRange - range of bytes successfully received

notifyFailure

public void notifyFailure(Session session,
                          Executor executor,
                          Status status)

Notify about failure, if appropriate. This method is idempotent.

Parameters:

session - session on which the message was transmitted

executor - executor used to issue notification

status - failure status

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<MsrpRequest>

next

public MsrpRequest next()

Specified by:

next in interface Iterator<MsrpRequest>

remove

public void remove()

Specified by:

remove in interface Iterator<MsrpRequest>

close

public void close()

Close the InputStream associated with this instance. This method is idempotent.

This class ensures that this method gets invoked after the final MsrpMessage is retrieved from next().

If the message has not been fully sent when this method is invoked, the message will be aborted.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable