javax.sip.header
Interface TimeStampHeader

All Superinterfaces:

java.lang.Cloneable, Header, java.io.Serializable

public interface TimeStampHeader

extends Header

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() Gets delay of TimeStampHeader.
float	getTimeStamp() Gets the timestamp value of this TimeStampHeader.
void	setDelay(float delay) Sets the new delay value of the TimestampHeader to the delay parameter passed to this method
void	setTimeStamp(float timeStamp) Sets the timestamp value of this TimeStampHeader to the new timestamp value passed to this method.

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, toString

Field Detail

NAME

public static final java.lang.String NAME

Name of TimeStampHeader

See Also:

Constant Field Values

Method Detail

setTimeStamp

public void setTimeStamp(float timeStamp)
                  throws InvalidArgumentException

Sets the timestamp value of this TimeStampHeader to the new timestamp value passed to this method.

Throws:

InvalidArgumentException - if the timestamp value argument is a negative value.

getTimeStamp

public float getTimeStamp()

Gets the timestamp value of this TimeStampHeader.

Returns:

the timestamp value of this TimeStampHeader

getDelay

public float getDelay()

Gets delay of TimeStampHeader. This method returns -1 if the delay parameter is not set.

Returns:

the delay value of this TimeStampHeader

setDelay

public void setDelay(float delay)
              throws InvalidArgumentException

Sets the new delay value of the TimestampHeader to the delay parameter passed to this method

Parameters:

delay - - the new float delay value

Throws:

InvalidArgumentException - if the delay value argumenmt is a negative value other than the default value -1.