ie.omk.smpp.util.SequenceNumberScheme Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smppapi Show documentation

Java Implementation of the Short Message Peer to Peer API.

The newest version!

package ie.omk.smpp.util;

/**
 * SMPP packet sequence numbering scheme interface. Implementations of this
 * interface provide a {@link ie.omk.smpp.Connection}with a unique number for
 * each call to nextNumber. This number is used as the packet's
 * sequence number in the SMPP header. The default implementation (
 * {@link DefaultSequenceScheme}) counts monotonically from 1 upwards for each
 * number requested. While this is the SMPP specification's recommended
 * behaviour, there is no requirement for 2 sequentially-requested numbers to be
 * numerically sequential.
 * 
 * @author Oran Kelly
 * @version 1.0
 */
public interface SequenceNumberScheme {

    int PEEK_UNSUPPORTED = -1;

    /**
     * Get the next number in this sequence's scheme. An implementation of this
     * interface must  guard against multi-threaded access to this method
     * to prevent more than one thread getting the same sequence number.
     */
    int nextNumber();

    /**
     * Get the next number in this sequence's scheme without causing it to move
     * to the next-in-sequence. This method returns the number that will be
     * returned by the next call to nextNumber without actually
     * increasing the sequence. Multiple calls to peek will
     * return the same number until a call to nextNumber is made.
     */
    int peek();

    /**
     * Get the nth next number in this sequence's scheme without causing it to
     * move to the next-in-sequence. This method returns the nth
     * next number in the sequence. This is an optional operation. If a sequence
     * numbering scheme does not support this operation, it should always return
     * {@link #PEEK_UNSUPPORTED}to the caller.
     */
    int peek(int nth);

    /**
     * Reset the sequence scheme to the beginning of the sequence.
     */
    void reset();
}