javax.sip.header

Interface RAckHeader

All Superinterfaces:

Cloneable, Header, Serializable

All Known Implementing Classes:

RAck

public interface RAckHeader
extends Header

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

The PRACK messages contain an RAck header field, which indicates the sequence number of the provisional response that is being acknowledged (each provisional response is given a sequence number, carried in the RSeq header field in the Provisional response). The acknowledgements are not cumulative, and the specifications recommend a single outstanding provisional response at a time, for purposes of congestion control.

The RAck header contains two numbers and a method tag. The first number is the sequence number from the RSeqHeader in the provisional response that is being acknowledged. The next number is the sequence number that is copied from the CSeqHeader along with the method tag, from the response that is being acknowledged.

For Example:
RAck: 776656 1 INVITE

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 RAckHeader.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCSeqNumber() Gets the CSeq sequence number of this RAckHeader.
String	getMethod() Gets the method of RAckHeader.
int	getRSeqNumber() Gets the RSeq sequence number of this RAckHeader.
void	setCSeqNumber(int cSeqNumber) Sets the sequence number value of the CSeqHeader of the provisional response being acknowledged.
void	setMethod(String method) Sets the method of RAckHeader, which correlates to the method of the CSeqHeader of the provisional response being acknowledged.
void	setRSeqNumber(int rSeqNumber) Sets the sequence number value of the RSeqHeader of the provisional response being acknowledged.

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, hashCode, toString

Field Detail

NAME

static final String NAME

Name of RAckHeader.

See Also:

Constant Field Values

Method Detail

setMethod

void setMethod(String method)
               throws ParseException

Sets the method of RAckHeader, which correlates to the method of the CSeqHeader of the provisional response being acknowledged.

Parameters:

method - - the new string value of the method of the RAckHeader

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the method value.

getMethod

String getMethod()

Gets the method of RAckHeader.

Returns:

method of RAckHeader.

setCSeqNumber

void setCSeqNumber(int cSeqNumber)
                   throws InvalidArgumentException

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

Parameters:

cSeqNumber - - the new cSeq number of this RAckHeader.

Throws:

InvalidArgumentException - if supplied value is less than zero.

getCSeqNumber

int getCSeqNumber()

Gets the CSeq sequence number of this RAckHeader.

Returns:

the integer value of the cSeq number of the RAckHeader.

setRSeqNumber

void setRSeqNumber(int rSeqNumber)
                   throws InvalidArgumentException

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

Parameters:

rSeqNumber - - the new rSeq number of this RAckHeader.

Throws:

InvalidArgumentException - if supplied value is less than zero.

getRSeqNumber

int getRSeqNumber()

Gets the RSeq sequence number of this RAckHeader.

Returns:

the integer value of the RSeq number of the RAckHeader.