|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CSeqHeader
A CSeq header field in a request contains a single decimal sequence number and the request method. The CSeq header field serves to identify and order transactions within a dialog, to provide a means to uniquely identify transactions, and to differentiate between new requests and request retransmissions. Two CSeq header fields are considered equal if the sequence number and the request method are identical.
Forked Requests:
Forked Requests must have the same CSeqHeader as there would be ambiguity
otherwise between these forked Requests and later BYE Requests issued by the
client user agent.
For Example:
CSeq: 4711 INVITE
Field Summary | |
---|---|
static java.lang.String |
NAME
Name of the CSeqHeader |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Compare this CSeqHeader for equality with another. |
java.lang.String |
getMethod()
Gets the method of CSeqHeader |
long |
getSeqNumber()
Gets the sequence number of this CSeqHeader. |
int |
getSequenceNumber()
Deprecated. This method is replaced with getSeqNumber() with
type long. |
void |
setMethod(java.lang.String method)
Sets the method of CSeqHeader |
void |
setSeqNumber(long sequenceNumber)
Sets the sequence number value of the CSeqHeader. |
void |
setSequenceNumber(int sequenceNumber)
Deprecated. This method is replaced with setSeqNumber(long) with
type long. |
Methods inherited from interface javax.sip.header.Header |
---|
clone, 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 method of the Request of this CSeqHeader
java.text.ParseException
- which signals that an error has been reached
unexpectedly while parsing the method value.java.lang.String getMethod()
void setSequenceNumber(int sequenceNumber) throws InvalidArgumentException
setSeqNumber(long)
with
type long.
sequenceNumber
- - the new sequence number of this CSeqHeader
InvalidArgumentException
- if supplied value is less than zero.int getSequenceNumber()
getSeqNumber()
with
type long.
void setSeqNumber(long sequenceNumber) throws InvalidArgumentException
sequenceNumber
- - the new sequence number of this CSeqHeader
InvalidArgumentException
- if supplied value is less than zero.long getSeqNumber()
boolean equals(java.lang.Object obj)
equals
in interface Header
equals
in class java.lang.Object
obj
- the object to compare this CSeqHeader with.
true
if obj
is an instance of this class
representing the same CseqHeader as this, false
otherwise.
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |