|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RAckHeader
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.
Field Summary | |
---|---|
static java.lang.String |
NAME
Name of RAckHeader. |
Method Summary | |
---|---|
int |
getCSeqNumber()
Gets the CSeq sequence number of this RAckHeader. |
java.lang.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(java.lang.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 |
---|
static final java.lang.String NAME
Method Detail |
---|
void setMethod(java.lang.String method) throws java.text.ParseException
method
- - the new string value of the method of the RAckHeader
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the method value.java.lang.String getMethod()
void setCSeqNumber(int cSeqNumber) throws InvalidArgumentException
cSeqNumber
- - the new cSeq number of this RAckHeader.
InvalidArgumentException
- if supplied value is less than zero.int getCSeqNumber()
void setRSeqNumber(int rSeqNumber) throws InvalidArgumentException
rSeqNumber
- - the new rSeq number of this RAckHeader.
InvalidArgumentException
- if supplied value is less than zero.int getRSeqNumber()
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |