Resource List Server

The following modules must be loaded before this module:

The name of the db table where resource lists subscription information is stored.

Default value is “rls_watchers”.

...
modparam("rls", "rlsubs_table", "rls_subscriptions")
...

The name of the db table where notified event specific information is stored.

Default value is “rls_presentity”.

...
modparam("rls", "rlpres_table", "rls_notify")
...

The period at which to check for expired information.

Default value is “100”.

...
modparam("rls", "clean_period", 100)
...

The timer period at which the server should attempt to send Notifies with the updated presence state of the subscribed list or watcher information.

Default value is “50”.

...
modparam("rls", "waitn_time", 10)
...

The maximum accepted expires for a subscription to a list.

Default value is “7200”.

...
modparam("rls", "max_expires", 10800)
...
		

The dimension of the hash table used to store subscription to a list. This parameter will be used as the power of 2 when computing table size.

Default value is “9 (512)”.

...
modparam("rls", "hash_size", 11)
...
		

The address of the xcap server.

Default value is “NULL”.

...
modparam("rls", "xcap_root", "http://192.168.2.132/xcap-root:800")
...
		

The code to be returned by rls_handle_subscribe function if the processed Subscribe is not a resource list Subscribe. This code can be used in an architecture with presence and rls servers collocated on the same machine, to call handle_subscribe on the message causing this code.

Default value is “0”.

...
modparam("rls", "to_presence_code", 10)
...
		

The default event that RLS handles is presence. If some other events should also be handled by RLS they should be added using this parameter. It can be set more than once.

Default value is “"presence"”.

...
modparam("rls", "rls_event", "dialog;sla")
...
		

The address of the presence server. It will be used as outbound proxy for Subscribe requests sent by the RLS server to bouncing on and off the proxy and having to include special processing for this messages in the proxy's configuration file.

...
modparam("rls", "presence_server", "sip:pres@opensips.org:5060")
...
		

This is the username that will be used in the Contact header for the 200 OK replies to SUBSCRIBE and in the following in-dialog NOTIFY requests, as well as for the SUBSCRIBE requests that are generated by the RLS server. The IP address, port and transport for the Contact will be automatically determined based on the interface where the SUBSCRIBE was received or sent from.

If set to an empty string, no username will be added to the contact and the contact will be built just out of the IP, port and transport.

Default value is “rls”.

...
modparam("rls", "contact_user", "rls")
...
		

This function detects if a Subscribe message should be handled by RLS. If not it replies with the configured to_presence_code. If it is, it extracts the dialog info and sends aggregate Notify requests with information for the list.

This function can be used from REQUEST_ROUTE.

...
For presence and rls on the same machine:
	modparam(rls, "to_presence_code", 10)

	if(is_method("SUBSCRIBE"))
	{	
		$var(ret_code)= rls_handle_subscribe();

		if($var(ret_code)== 10)
				handle_subscribe();

		t_release();
	}

For rls only:
	if(is_method("SUBSCRIBE"))
	{
		rls_handle_subscribe();
		t_release();
	}

...

This function has to be called for Notify messages sent by presence servers in reply to the Subscribe messages sent by RLS.

This function can be used from REQUEST_ROUTE.

It can return 3 codes:

...
if($rm=="NOTIFY")
    rls_handle_notify();
...

Triggers updating backend subscriptions after a resources-list or rls-services document has been updated.

Name: rls_update_subscriptions

Parameters:

MI FIFO Command Format:

opensips-cli -x mi rls_update_subscriptions sip:alice@atlanta.com