Apache CXF API

org.apache.cxf.ws.rm
Interface RetransmissionQueue

All Known Implementing Classes:
RetransmissionQueueImpl

public interface RetransmissionQueue


Field Summary
static String DEFAULT_BASE_RETRANSMISSION_INTERVAL
           
static int DEFAULT_EXPONENTIAL_BACKOFF
           
 
Method Summary
 void addUnacknowledged(Message message)
          Accepts a new message for possible future retransmission.
 int countUnacknowledged()
           
 int countUnacknowledged(SourceSequence seq)
           
 RetryStatus getRetransmissionStatus(SourceSequence seq, long num)
          Returns the retransmission status for the specified message.
 Map<Long,RetryStatus> getRetransmissionStatuses(SourceSequence seq)
          Return the retransmission status of all the messages assigned to the sequence.
 List<Long> getUnacknowledgedMessageNumbers(SourceSequence seq)
           
 boolean isEmpty()
           
 void purgeAcknowledged(SourceSequence seq)
          Purge all candidates for the given sequence that have been acknowledged.
 void purgeAll(SourceSequence seq)
          Purge all candidates for the given sequence.
 void resume(SourceSequence seq)
          Resumes the retransmission attempts for the specified sequence
 void start()
          Initiate resends.
 void stop(SourceSequence seq)
          Stops retransmission queue.
 void suspend(SourceSequence seq)
          Suspends the retransmission attempts for the specified sequence
 

Field Detail

DEFAULT_BASE_RETRANSMISSION_INTERVAL

static final String DEFAULT_BASE_RETRANSMISSION_INTERVAL
See Also:
Constant Field Values

DEFAULT_EXPONENTIAL_BACKOFF

static final int DEFAULT_EXPONENTIAL_BACKOFF
See Also:
Constant Field Values
Method Detail

countUnacknowledged

int countUnacknowledged(SourceSequence seq)
Parameters:
seq - the sequence under consideration
Returns:
the number of unacknowledged messages for that sequence

countUnacknowledged

int countUnacknowledged()
Returns:
the total number of unacknowledged messages in this queue

isEmpty

boolean isEmpty()
Returns:
true if there are no unacknowledged messages in the queue

addUnacknowledged

void addUnacknowledged(Message message)
Accepts a new message for possible future retransmission. Implementations must call the RMEndpoint.handleAccepted() method for each accepted message.

Parameters:
message - the message context.

purgeAcknowledged

void purgeAcknowledged(SourceSequence seq)
Purge all candidates for the given sequence that have been acknowledged. Implementations must call the RMEndpoint.handleAcknowledgment() method for each acknowledged message.

Parameters:
seq - the sequence object.

purgeAll

void purgeAll(SourceSequence seq)
Purge all candidates for the given sequence.

Parameters:
seq - the sequence object

getUnacknowledgedMessageNumbers

List<Long> getUnacknowledgedMessageNumbers(SourceSequence seq)
Parameters:
seq -
Returns:

getRetransmissionStatus

RetryStatus getRetransmissionStatus(SourceSequence seq,
                                    long num)
Returns the retransmission status for the specified message.

Parameters:
seq -
num -
Returns:

getRetransmissionStatuses

Map<Long,RetryStatus> getRetransmissionStatuses(SourceSequence seq)
Return the retransmission status of all the messages assigned to the sequence.

Parameters:
seq -
Returns:

start

void start()
Initiate resends.


stop

void stop(SourceSequence seq)
Stops retransmission queue.

Parameters:
seq -

suspend

void suspend(SourceSequence seq)
Suspends the retransmission attempts for the specified sequence

Parameters:
seq -

resume

void resume(SourceSequence seq)
Resumes the retransmission attempts for the specified sequence

Parameters:
seq -

Apache CXF API

Apache CXF