com.cloudhopper.smpp.util

Class SequenceNumber

java.lang.Object

com.cloudhopper.smpp.util.SequenceNumber

public class SequenceNumber
extends Object

Utility class for atomically generating SMPP PDU sequence numbers. This implementation will atomically increment the sequence number and wrap it around back to 1 when it hits the max 0x7FFFFFFF.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_VALUE
static int	MAX_VALUE
static int	MIN_VALUE

Constructor Summary

Constructors

Constructor and Description
SequenceNumber()
SequenceNumber(int initialValue)

Method Summary

Methods

Modifier and Type	Method and Description
static void	assertValid(int sequenceNumber)
int	next() Get the next number in this sequence's scheme.
int	peek() Get the next number in this sequence's scheme without causing it to move to the next-in-sequence.
void	reset() Reset the sequence scheme to the beginning of the sequence (min value which is 1).

Methods inherited from class java.lang.Object

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

Field Detail

MIN_VALUE

public static final int MIN_VALUE

See Also:

Constant Field Values

DEFAULT_VALUE

public static final int DEFAULT_VALUE

See Also:

Constant Field Values

MAX_VALUE

public static final int MAX_VALUE

See Also:

Constant Field Values

Constructor Detail

SequenceNumber

public SequenceNumber()

SequenceNumber

public SequenceNumber(int initialValue)
               throws InvalidSequenceNumberException

Throws:

InvalidSequenceNumberException

Method Detail

next

public int next()

Get the next number in this sequence's scheme. This method is synchronized so its safe for multiple threads to call.

peek

public int peek()

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 next() without actually increasing the sequence. Multiple calls to peek will return the same number until a call to next() is made.

reset

public void reset()

Reset the sequence scheme to the beginning of the sequence (min value which is 1).

assertValid

public static void assertValid(int sequenceNumber)
                        throws InvalidSequenceNumberException

Throws:

InvalidSequenceNumberException