public interface SessionTimer
Modifier and Type | Method and Description |
---|---|
Request |
generateSessionRefreshRequest(String method)
Generate a session-refresh re-INVITE or UPDATE request using the dialog's current
session timer options.
|
Request |
generateSessionRefreshRequest(String method,
SessionTimerOptions newOptions)
Generate a session-refresh re-INVITE or UPDATE request using the specified
session timer options.
|
Response |
generateSessionRefreshResponse(Request refresh)
Generates a 200 OK response to a session refresh request, based on the session timer
headers in the request.
|
Response |
generateSessionRefreshResponse(Request refresh,
SessionTimerOptions newOptions)
Generates a 200 OK response to a session refresh request, based on the session timer
headers in the request and the given session timer options.
|
SessionTimerOptions |
getCurrentSessionTimerOptions()
Get the dialog's currently configured session timer options.
|
boolean |
isActive()
Determine if the dialog's session timer is active.
|
boolean |
isExpired()
Determine if the dialog's session timer has expired.
|
boolean isActive()
boolean isExpired()
SessionTimerOptions getCurrentSessionTimerOptions()
SessionTimerOptions.NONE
if there is no session timer activeRequest generateSessionRefreshRequest(String method)
method
- the request method, must be "INVITE" or "UPDATE".Request
that may be used as a session refresh request. The request
will contain Session-Expires and Min-SE headers based on the current session timer
options.
Note that INVITE requests should contain the current SDP for the session. it is the application's responsibility to add the SDP body to refresh requests.
Request generateSessionRefreshRequest(String method, SessionTimerOptions newOptions)
method
- the request method, must be "INVITE" or "UPDATE".newOptions
- the refreshing parties' desired new session timer options. Note that
the other party may adjust these options in the response, or even reject the request.
An application should use getCurrentSessionTimerOptions()
after
a successful session refresh to see what options were actually agreed.SessionTimerOptions.NONE
is ignored, in this case the dialog's
current session timer options will be reused in the refresh.SessionTimerOptions.PROXY
is not permitted here as proxy mode
may only be selected at dialog creation time.Request
that may be used as a session refresh request. The request
will contain Session-Expires and Min-SE headers based on the given session timer
options.
Note that INVITE requests should contain the current SDP for the session. it is the application's responsibility to add the SDP body to refresh requests.
IllegalArgumentException
- if method is not "INVITE" or "UPDATE";
or if newOptions is SessionTimerOptions.PROXY
Response generateSessionRefreshResponse(Request refresh)
Note that INVITE responses should contain the current SDP for the session. it is the application's responsibility to add the SDP body to refresh responses.
refresh
- a session refresh re-INVITE or UPDATE requestResponse generateSessionRefreshResponse(Request refresh, SessionTimerOptions newOptions)
Note that INVITE responses should contain the current SDP for the session. it is the application's responsibility to add the SDP body to refresh responses.
refresh
- a session refresh re-INVITE or UPDATE requestnewOptions
- the refreshee parties' desired new session timer options. Using
the value SessionTimerOptions.NONE
here is ignored, in this case the
dialog's current session timer options will be used in the response.SessionTimerOptions.PROXY
is not permitted here as proxy mode
may only be selected at dialog creation time.IllegalArgumentException
- if the request method is not "INVITE" or "UPDATE";
or if newOptions is SessionTimerOptions.PROXY