javax.sip.header

Interface RSeqHeader

All Superinterfaces:

Cloneable, Header, Serializable

All Known Implementing Classes:

RSeq

public interface RSeqHeader
extends Header

This interface represents the RSeq header, as defined by RFC3262, this header is not part of RFC3261.

The RSeq header is used in provisional responses in order to transmit them reliably. It contains a single numeric value from 1 to 2**32-1. The value of the RSeq in each subsequent reliable provisional response for the same request MUST be greater by exactly one. RSeq numbers MUST NOT wrap around. Because the initial one is chosen to be less than 2**31 - 1, but the maximum is 2**32 - 1, there can be up to 2**31 reliable provisional responses per request, which is more than sufficient. As the RSeq numbering space is within a single transaction. This means that provisional responses for different requests MAY use the same values for the RSeq number.

A server must ignore Headers that it does not understand. A proxy must not remove or modify Headers that it does not understand.

Version:

1.2

Author:

BEA Systems, NIST

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of RSeqHeader

Method Summary

Methods

Modifier and Type	Method and Description
int	getSequenceNumber() Gets the sequence number of this RSeqHeader.
void	setSequenceNumber(int sequenceNumber) Sets the sequence number value of the RSeqHeader of the provisional response.

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

NAME

static final String NAME

Name of RSeqHeader

See Also:

Constant Field Values

Method Detail

setSequenceNumber

void setSequenceNumber(int sequenceNumber)
                       throws InvalidArgumentException

Sets the sequence number value of the RSeqHeader of the provisional response. The sequence number MUST be expressible as a 32-bit unsigned integer and MUST be less than 2**31.

Parameters:

sequenceNumber - - the new Sequence number of this RSeqHeader

Throws:

InvalidArgumentException - if supplied value is less than zero.

getSequenceNumber

int getSequenceNumber()

Gets the sequence number of this RSeqHeader.

Returns:

the integer value of the Sequence number of the RSeqHeader