|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TimeStampHeader
The Timestamp header field describes when the UAC sent the request to the UAS. When a 100 (Trying) response is generated, any Timestamp header field present in the request MUST be copied into this 100 (Trying) response. If there is a delay in generating the response, the UAS SHOULD add a delay value into the Timestamp value in the response. This value MUST contain the difference between the time of sending of the response and receipt of the request, measured in seconds. Although there is no normative behavior defined here that makes use of the header, it allows for extensions or SIP applications to obtain RTT estimates, that may be used to adjust the timeout value for retransmissions.
For Example:
Timestamp: 54
Field Summary | |
---|---|
static java.lang.String |
NAME
Name of TimeStampHeader |
Method Summary | |
---|---|
float |
getDelay()
Deprecated. This method is replaced with getTimeDelay() . |
long |
getTime()
Gets the timestamp value of this TimeStampHeader. |
int |
getTimeDelay()
Gets delay of TimeStampHeader. |
float |
getTimeStamp()
Deprecated. This method is replaced with getTime() . |
void |
setDelay(float delay)
Deprecated. This method is replaced with setTimeDelay(int) . |
void |
setTime(long timeStamp)
Sets the timestamp value of this TimeStampHeader to the new timestamp value passed to this method. |
void |
setTimeDelay(int delay)
Sets the new delay value of the TimestampHeader to the delay parameter passed to this method |
void |
setTimeStamp(float timeStamp)
Deprecated. This method is replaced with setTimeStamp(float) . |
Methods inherited from interface javax.sip.header.Header |
---|
clone, equals, getName, hashCode, toString |
Field Detail |
---|
static final java.lang.String NAME
Method Detail |
---|
void setTimeStamp(float timeStamp) throws InvalidArgumentException
setTimeStamp(float)
.
timeStamp
- - the new float timestamp value
InvalidArgumentException
- if the timestamp value argument is a
negative value.float getTimeStamp()
getTime()
.
long getTime()
void setTime(long timeStamp) throws InvalidArgumentException
timeStamp
- - the new long timestamp value
InvalidArgumentException
- if the timestamp value argument is a
negative value.float getDelay()
getTimeDelay()
.
-1
if the
delay parameter is not set.
void setDelay(float delay) throws InvalidArgumentException
setTimeDelay(int)
.
delay
- - the new float delay value
InvalidArgumentException
- if the delay value argumenmt is a
negative value other than the default value -1
.int getTimeDelay()
-1
if the
delay parameter is not set.
void setTimeDelay(int delay) throws InvalidArgumentException
delay
- - the new int delay value
InvalidArgumentException
- if the delay value argumenmt is a
negative value other than the default value -1
.
|
JSIP API v1.2 November 2006 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |