Skip to content

Commit

Permalink
[pua/presence_reginfo] more in doc formating
Browse files Browse the repository at this point in the history
  • Loading branch information
bogdan-iancu committed Apr 18, 2024
1 parent 58c88e7 commit 6beb906
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 2 deletions.
106 changes: 106 additions & 0 deletions modules/presence_reginfo/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
presence_reginfo Module

Carsten Bock

<carsten@ng-voice.com>

Edited by

Carsten Bock

<carsten@ng-voice.com>
__________________________________________________________

Table of Contents

1. Admin Guide

1.1. Overview
1.2. Dependencies

1.2.1. OpenSIPS Modules
1.2.2. External Libraries or Applications

1.3. Parameters

1.3.1. default_expires (int)
1.3.2. aggregate_presentities (int)

1.4. Functions

List of Examples

1.1. Set default_expires parameter
1.2. Set aggregate_presentities parameter

Chapter 1. Admin Guide

1.1. Overview

The module enables the handling of "Event: reg" (as defined in
RFC 3680) inside of the presence module. This can be used
distribute the registration-info status to the subscribed
watchers.

The module does not currently implement any authorization
rules. It assumes that publish requests are only issued by an
authorized application and subscribe requests only by
authorized users. Authorization can thus be easily done in
OpenSIPS configuration file before calling handle_publish() and
handle_subscribe() functions.

Note: This module only activates the processing of the "reg" in
the presence module. To send dialog-info to watchers you also
need a source which PUBLISH the reg info to the presence
module. For example you can use the pua_reginfo module or any
external component. This approach allows to have the presence
server and the reg-info aware publisher (e.g. the main proxy)
on different OpenSIPS instances.

1.2. Dependencies

1.2.1. OpenSIPS Modules

The following modules must be loaded before this module:
* presence.

1.2.2. External Libraries or Applications

None.

1.3. Parameters

1.3.1. default_expires (int)

The default expires value used when missing from SUBSCRIBE
message (in seconds).

Default value is “3600”.

Example 1.1. Set default_expires parameter
...
modparam("presence_reginfo", "default_expires", 3600)
...

1.3.2. aggregate_presentities (int)

Whether to aggregate in a single notify body all registration
presentities. Useful to have all registrations on first NOTIFY
following initial SUBSCRIBE.

Default value is “0” (disabled).

Example 1.2. Set aggregate_presentities parameter
...
modparam("presence_reginfo", "ag
gregate_presentities", 1)
...

1.4. Functions

None to be used in configuration file.

Documentation Copyrights:

Copyright © 2011-2023 Carsten Bock, carsten@ng-voice.com,
http://www.ng-voice.com
Empty file.
2 changes: 1 addition & 1 deletion modules/presence_reginfo/doc/presence_reginfo.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding='ISO-8859-1'?>
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

Expand Down
Empty file.
2 changes: 1 addition & 1 deletion modules/pua_reginfo/doc/pua_reginfo.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding='ISO-8859-1'?>
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

Expand Down

0 comments on commit 6beb906

Please sign in to comment.