Skip to content

SIP Graceful shutdown feature implementation and documentation #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

SIP Graceful shutdown feature implementation and documentation #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3a6b83
SIP Graceful shutdown feature implementation and documentation
bkrok Aug 17, 2017
3f14042
Merge branch 'master' into issue#20-graceful-shutdown
bkrok Aug 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions resources/sip11/docs/sources-asciidoc/src/main/asciidoc/Author_Group.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[[_author_group]]
= Authors

Bartosz Baranowski {author-email-bartosz}

Eduardo Martins {author-email-eduardo}

Grzegorz Figiel www.pro-ids.com grzegorz.figiel (at) pro-ids.com

Dominik Blacha www.pro-ids.com dominik.blacha (at) pro-ids.com
12 changes: 12 additions & 0 deletions resources/sip11/docs/sources-asciidoc/src/main/asciidoc/Chapter-Graceful_Stop.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[[_ra_graceful_stop]]
= Graceful Stop

[[_ra_graceful_stop_support]]
== Graceful Stop support

The RA supports Graceful container stop feature. In Graceful Stop state the RA rejects incoming initial events - it rejects new activities creation.

[[_ra_graceful_stop_response]]
== Graceful Stop reject support

When the RA is in Graceful Stopping mode the `SIP/2.0 503 Service unavailable` is send as a response for every new dialog creation request.
8 changes: 7 additions & 1 deletion resources/sip11/docs/sources-asciidoc/src/main/asciidoc/Revision_History.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
[appendix]
= Revision History


.Revision History
[cols="1,1,1,1", frame="all", options="header"]
|===
| Revision number | Date | Author | Description
| 1.0 | 2009-12-30 | Eduardo Martins | Creation of the {this-platform} JAIN SLEE SIP11 RA User Guide.
| 1.1 | 2016-09-29 | ProIDS | Graceful Stop feature chapter added.
|===

:sectnums:
6 changes: 6 additions & 0 deletions resources/sip11/docs/sources-asciidoc/src/main/asciidoc/User_Guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ include::Chapter-Clustering.adoc[]

:leveloffset: 1

include::Chapter-Graceful_Stop.adoc[]

:leveloffset: 0

:leveloffset: 1

include::Revision_History.adoc[]

:leveloffset: 0
11 changes: 8 additions & 3 deletions ...ces/sip11/docs/sources-asciidoc/src/main/asciidoc/ra/Section-Configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,14 @@ The following table enumerates the configuration properties:
| javax.sip. OUTBOUND_PROXY | sets the outbound proxy of the SIP Stack. The format for this string is "ipaddress:port/transport" i.e. 129.1.22.333:5060/UDP. This property is optional | java.lang.String |
| javax.sip. PORT | the port to which the SIP stack should listen | java.lang.Integer | 5060
| javax.sip. TRANSPORT | the list of supported transports, separated with "," | java.lang.String | UDP
| org.mobicents. ha.javax.sip. BALANCERS | the list of SIP balancers, in the form of "HOST:PORT", separated by ";", it is only used if the heart beat service property is defined | java.lang.String |
| org.mobicents. ha.javax.sip. LoadBalancer HeartBeating ServiceClassName | the name of the class responsible for the heart beats exchanged with the platform's SIP Balancer - if not specified the JAIN SIP HA stack won't use such feature | java.lang.String |
| org.mobicents. javax.sip. LOOSE_DIALOG _VALIDATION | controls validation of CSeq number for dialog messages. Set to true allows out of sequence messages to be accepted. | java.lang.Boolean |
| org.mobicents. ha.javax.sip. BALANCERS | the list of SIP balancers, in the form of "HOST:PORT", separated by ";", it is only used if the heart beat service property is defined | java.lang.String |
| org.mobicents. ha.javax.sip. LoadBalancer HeartBeating ServiceClassName | the name of the class responsible for the heart beats exchanged with the platform's SIP Balancer - if not specified the JAIN SIP HA stack won't use such feature | java.lang.String |
| org.mobicents. javax.sip. LOOSE_DIALOG _VALIDATION | controls validation of CSeq number for dialog messages. Set to true allows out of sequence messages to be accepted. | java.lang.Boolean |
| defaultActiveSessionsThreshold | This property defines container default Active Sessions Threshold (AST) value in graceful shutdown resource adaptor mode.
| java.lang.Integer |
| defaultGracefulShutdownWaitTime | This property defines the maximum time period when the container is waiting for finishing existing sessions/activities in
graceful shutdown resource adaptor mode.
| java.lang.Long |
|===

IMPORTANT: Spaces where introduced in `Property Name` column values, to correctly render the table.
Expand Down
13 changes: 13 additions & 0 deletions resources/sip11/docs/sources/src/main/resources/en-US/Author_Group.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,17 @@
<surname>Martins</surname>
<email>&AUTHOR.EMAIL.EDUARDO;</email>
</author>
<author>
<firstname>Grzegorz</firstname>
<surname>Figiel</surname>
<affiliation>ProIDS www.pro-ids.com</affiliation>
<email>grzegorz.figiel (at) pro-ids.com</email>
</author>
<author>
<firstname>Dominik</firstname>
<surname>Blacha</surname>
<affiliation>ProIDS www.pro-ids.com</affiliation>
<email>dominik.blacha (at) pro-ids.com</email>
</author>

</authorgroup>
16 changes: 16 additions & 0 deletions resources/sip11/docs/sources/src/main/resources/en-US/Chapter-Graceful_Stop.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent">
%BOOK_ENTITIES;
]>
<chapter id="ra_graceful_stop">
<title>Graceful Stop</title>
<section id="ra_graceful_stop">
<title>Graceful Stop support</title>
<para>The RA supports Graceful container stop feature. In Graceful Stop state the RA rejects incoming initial events - it rejects new activities creation.</para>
</section>
<section id="ra_graceful_stop_response">
<title>Graceful Stop reject support</title>
<para>When the RA is in Graceful Stopping mode the <literal>SIP/2.0 503 Service unavailable</literal> is send as a response for every new dialog creation request.</para>
</section>
</chapter>
62 changes: 39 additions & 23 deletions resources/sip11/docs/sources/src/main/resources/en-US/Revision_History.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,39 @@
<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent">%BOOK_ENTITIES;]>
<appendix
id="revision_history">
<title>Revision History</title>
<simpara>
<revhistory>
<revision>
<revnumber>1.0</revnumber>
<date>Tue Dec 30 2009</date>
<author>
<firstname>Eduardo</firstname>
<surname>Martins</surname>
</author>
<revdescription>
<simplelist>
<member>Creation of the &THIS.PLATFORM; JAIN SLEE SIP11 RA User Guide.</member>
</simplelist>
</revdescription>
</revision>
</revhistory>
</simpara>
</appendix>
<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "User_Guide.ent">
%BOOK_ENTITIES;
]>
<appendix
id="revision_history">
<title>Revision History</title>
<simpara>
<revhistory>
<revision>
<revnumber>1.0</revnumber>
<date>Tue Dec 30 2009</date>
<author>
<firstname>Eduardo</firstname>
<surname>Martins</surname>
</author>
<revdescription>
<simplelist>
<member>Creation of the &THIS.PLATFORM; JAIN SLEE SIP11 RA User Guide.</member>
</simplelist>
</revdescription>
</revision>
<revision>
<revnumber>1.1</revnumber>
<date>2016-09-29</date>
<author>
<firstname>ProIDS</firstname>
<surname>ProIDS</surname>
</author>
<revdescription>
<simplelist>
<member>Graceful Stop feature chapter added</member>
</simplelist>
</revdescription>
</revision>
</revhistory>
</simpara>
</appendix>
1 change: 1 addition & 0 deletions resources/sip11/docs/sources/src/main/resources/en-US/User_Guide.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ra/Chapter-Resource_Adaptor.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Chapter-Setup.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Chapter-Clustering.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Chapter-Graceful_Stop.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/>
<index/>
</book>
Loading