org.mobicents.ext.javax.sip.congestion

Class CongestionControlMessageValve

java.lang.Object

org.mobicents.ext.javax.sip.congestion.CongestionControlMessageValve

All Implemented Interfaces:

gov.nist.javax.sip.stack.SIPMessageValve, org.mobicents.commons.congestion.CongestionListener

public class CongestionControlMessageValve
extends Object
implements gov.nist.javax.sip.stack.SIPMessageValve, org.mobicents.commons.congestion.CongestionListener

This is a congestion control valve that JSIP apps can use to stop traffic without breaking existing dialogs when the number of server transactions or dialogs or the memory or CPU reaches a given limit.
See CongestionControlTimerTask for the list of properties A background task gathers information about the current server congestion. The data collection interval can be adjusted, and congestion control deactivated, by setting the interval to 0 or a negative value through org.mobicents.ext.javax.sip.congestion.CONGESTION_CONTROL_MONITOR_INTERVAL property The drop policy is specified in org.mobicents.ext.javax.sip.congestion.DROP_RESPONSE_STATUS where "0" or negative value means silent drop and any positive number will be interpreted as the status code of the error response that will be generated. To enable this in your application you must specify this property: gov.nist.javax.sip.SIP_MESSAGE_VALVE=org.mobicents.ext.javax.sip.congestion.CongestionControlMessageValve It is advised to extend this class to add your application-specific control conditions or if you need to add any header to the response generated back (like Retry-After Header) by overriding the modifyCongestionResponse(SIPResponse response).

Author:

vladimirralev, jean.deruelle@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected ScheduledFuture	congestionControlTimerFuture
protected int	dropResponseStatus
protected SipStackExtension	sipStack

Constructor Summary

Constructors

Constructor and Description
CongestionControlMessageValve()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
void	init(javax.sip.SipStack stack)
boolean	isRejectMessages()
protected void	modifyCongestionResponse(gov.nist.javax.sip.message.SIPResponse response)
void	onCongestionFinish(String source)
void	onCongestionStart(String source)
boolean	processRequest(gov.nist.javax.sip.message.SIPRequest request, gov.nist.javax.sip.stack.MessageChannel messageChannel)
boolean	processResponse(javax.sip.message.Response response, gov.nist.javax.sip.stack.MessageChannel messageChannel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sipStack

protected SipStackExtension sipStack

congestionControlTimerFuture

protected transient ScheduledFuture congestionControlTimerFuture

dropResponseStatus

protected int dropResponseStatus

Constructor Detail

CongestionControlMessageValve

public CongestionControlMessageValve()

Method Detail

processRequest

public boolean processRequest(gov.nist.javax.sip.message.SIPRequest request,
                     gov.nist.javax.sip.stack.MessageChannel messageChannel)

Specified by:

processRequest in interface gov.nist.javax.sip.stack.SIPMessageValve

modifyCongestionResponse

protected void modifyCongestionResponse(gov.nist.javax.sip.message.SIPResponse response)

processResponse

public boolean processResponse(javax.sip.message.Response response,
                      gov.nist.javax.sip.stack.MessageChannel messageChannel)

Specified by:

processResponse in interface gov.nist.javax.sip.stack.SIPMessageValve

destroy

public void destroy()

Specified by:

destroy in interface gov.nist.javax.sip.stack.SIPMessageValve

init

public void init(javax.sip.SipStack stack)

Specified by:

init in interface gov.nist.javax.sip.stack.SIPMessageValve

onCongestionStart

public void onCongestionStart(String source)

Specified by:

onCongestionStart in interface org.mobicents.commons.congestion.CongestionListener

onCongestionFinish

public void onCongestionFinish(String source)

Specified by:

onCongestionFinish in interface org.mobicents.commons.congestion.CongestionListener

isRejectMessages

public boolean isRejectMessages()

Returns:

the rejectMessages