CAF: Call Legs Resync - Revision history

Allyntree: /* Scenario 3: CAF application is restarted */

2022-09-06T14:29:24Z

Scenario 3: CAF application is restarted

← Older revision		Revision as of 10:29, 6 September 2022
Line 108:		Line 108:
	** Destructor of all call flows is called		** Destructor of all call flows is called
	* When the application is restarted		* When the application is restarted
	** => This is exactly the same scenario as the end of Scenario 2 after step 'toolpack_engine pushes information to CAF library'.		** This is exactly the same scenario as the end of Scenario 2 after step 'toolpack_engine pushes information to CAF library'.

	= For more information... =		= For more information... =

Allyntree: typos

2022-09-06T14:28:54Z

typos

Abrassard at 11:32, 23 January 2014

2014-01-23T11:32:32Z

← Older revision		Revision as of 07:32, 23 January 2014
Line 103:		Line 103:
	[[Image:CAFCallFlow_examples_scenario_3.png\|thumb\|480px\|Example scenario 3]]		[[Image:CAFCallFlow_examples_scenario_3.png\|thumb\|480px\|Example scenario 3]]

	This is exactly same scenario as the end of Scenario 2 after toolpack_engine pushes information to CAF library.		* If the application is quitting in a 'clean' manner
			** 'OnLegFreed()' is called for all call legs (Leg-A, Leg-B, Leg-C, Leg-D and Leg-E)
			** Destructor of all call flows is called
			* When the application is restarted
			** => This is exactly same scenario as the end of Scenario 2 after step 'toolpack_engine pushes information to CAF library'.

	= For more information... =		= For more information... =

Abrassard at 12:42, 19 October 2012

2012-10-19T12:42:33Z

← Older revision		Revision as of 08:42, 19 October 2012
Line 41:		Line 41:

	=== Scenario 1: toolpack_engine quickly restarted ===		=== Scenario 1: toolpack_engine quickly restarted ===
	[[Image:CAFCallFlow_examples_scenario_1.png\|thumb\|480px\|Example scenario~~: Initial state~~]]		[[Image:CAFCallFlow_examples_scenario_1.png\|thumb\|480px\|Example scenario 1]]

	* CAF Application is notified		* CAF Application is notified
Line 64:		Line 64:

	=== Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds ===		=== Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds ===
	[[Image:CAFCallFlow_examples_scenario_2.png\|thumb\|480px\|Example scenario~~: Initial state~~]]		[[Image:CAFCallFlow_examples_scenario_2.png\|thumb\|480px\|Example scenario 2]]

	* CAF Application is notified		* CAF Application is notified
Line 101:		Line 101:

	=== Scenario 3: CAF application is restarted ===		=== Scenario 3: CAF application is restarted ===
	[[Image:CAFCallFlow_examples_scenario_3.png\|thumb\|480px\|Example scenario~~: Initial state~~]]		[[Image:CAFCallFlow_examples_scenario_3.png\|thumb\|480px\|Example scenario 3]]

	This is exactly same scenario as the end of Scenario 2 after toolpack_engine pushes information to CAF library.		This is exactly same scenario as the end of Scenario 2 after toolpack_engine pushes information to CAF library.

Abrassard at 12:41, 19 October 2012

2012-10-19T12:41:44Z

← Older revision		Revision as of 08:41, 19 October 2012
Line 28:		Line 28:

	== Example scenarios ==		== Example scenarios ==
			[[Image:CAFCallFlow_examples_initial.png\|thumb\|480px\|Example scenario: Initial state]]

	In all the scenarios below, let's consider the following situation:		In all the scenarios below, let's consider the following situation:
	* Leg-A: Ringing		* Leg-A: Ringing
Line 38:		Line 40:
	* Leg-E and Mixer-1 are joined (connected)		* Leg-E and Mixer-1 are joined (connected)

	[[Image:~~CAFCallFlow_examples_initial~~.png\|thumb\|480px\|Example scenario: Initial state]]		=== Scenario 1: toolpack_engine quickly restarted ===
			[[Image:CAFCallFlow_examples_scenario_1.png\|thumb\|480px\|Example scenario: Initial state]]

	~~=== Scenario 1: toolpack_engine quickly restarted ===~~
	* CAF Application is notified		* CAF Application is notified
	** ''OnCmcLibNotReady()''		** ''OnCmcLibNotReady()''
Line 61:		Line 63:
	** ''OnCmcLibReady()''		** ''OnCmcLibReady()''

	[[Image:~~CAFCallFlow_examples_scenario_1~~.png\|thumb\|480px\|Example scenario: Initial state]]		=== Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds ===
			[[Image:CAFCallFlow_examples_scenario_2.png\|thumb\|480px\|Example scenario: Initial state]]

	~~=== Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds ===~~
	* CAF Application is notified		* CAF Application is notified
	** ''OnCmcLibNotReady()''		** ''OnCmcLibNotReady()''
Line 98:		Line 100:
	** ''OnCmcLibReady()''		** ''OnCmcLibReady()''

	[[Image:~~CAFCallFlow_examples_scenario_2~~.png\|thumb\|480px\|Example scenario: Initial state]]		=== Scenario 3: CAF application is restarted ===
			[[Image:CAFCallFlow_examples_scenario_3.png\|thumb\|480px\|Example scenario: Initial state]]

	~~=== Scenario 3: CAF application is restarted ===~~
	This is exactly same scenario as the end of Scenario 2 after toolpack_engine pushes information to CAF library.		This is exactly same scenario as the end of Scenario 2 after toolpack_engine pushes information to CAF library.

	~~[[Image:CAFCallFlow_examples_scenario_3.png\|thumb\|480px\|Example scenario: Initial state]]~~

	= For more information... =		= For more information... =

Abrassard: /* Example scenarios */

2012-10-19T12:38:51Z

Example scenarios

← Older revision		Revision as of 08:38, 19 October 2012
Line 37:		Line 37:
	* Mixer-1: Ready		* Mixer-1: Ready
	* Leg-E and Mixer-1 are joined (connected)		* Leg-E and Mixer-1 are joined (connected)

			[[Image:CAFCallFlow_examples_initial.png\|thumb\|480px\|Example scenario: Initial state]]

	=== Scenario 1: toolpack_engine quickly restarted ===		=== Scenario 1: toolpack_engine quickly restarted ===
Line 58:		Line 60:
	* Ready to continue		* Ready to continue
	** ''OnCmcLibReady()''		** ''OnCmcLibReady()''

			[[Image:CAFCallFlow_examples_scenario_1.png\|thumb\|480px\|Example scenario: Initial state]]

	=== Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds ===		=== Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds ===
Line 93:		Line 97:
	* Ready to continue		* Ready to continue
	** ''OnCmcLibReady()''		** ''OnCmcLibReady()''

			[[Image:CAFCallFlow_examples_scenario_2.png\|thumb\|480px\|Example scenario: Initial state]]

	=== Scenario 3: CAF application is restarted ===		=== Scenario 3: CAF application is restarted ===
	This is exactly same scenario as the end of Scenario 2 after toolpack_engine pushes information to CAF library.		This is exactly same scenario as the end of Scenario 2 after toolpack_engine pushes information to CAF library.

			[[Image:CAFCallFlow_examples_scenario_3.png\|thumb\|480px\|Example scenario: Initial state]]

	= For more information... =		= For more information... =

Abrassard: /* CAF application */

2012-10-19T12:01:57Z

CAF application

← Older revision		Revision as of 08:01, 19 October 2012
Line 20:		Line 20:

	=== CAF application ===		=== CAF application ===
	The call control application ~~based on the~~ [[~~CAF_Call_interface~~]] ~~API~~ will re-build it's call leg contexts by getting information ~~from~~ [[Toolpack_Application:toolpack_engine\|toolpack_engine]].		The CAF call control application that was disconnected from [[Toolpack_Application:toolpack_engine\|toolpack_engine]] will update (or re-build) it's call leg contexts by getting information automatically pushed by [[Toolpack_Application:toolpack_engine\|toolpack_engine]] upon re-connection.

	All active (answered) calls will be re-synchronized from [[Toolpack_Application:toolpack_engine\|toolpack_engine]].		All active (answered) calls will be re-synchronized from [[Toolpack_Application:toolpack_engine\|toolpack_engine]].

Abrassard: /* Call Legs Resynchronization */

2012-10-19T12:00:42Z

Call Legs Resynchronization

← Older revision		Revision as of 08:00, 19 October 2012
Line 2:		Line 2:
	Since the [[Toolpack]] framework has been designed for HA ([[High_Availability_Overview]]), it's mandatory that an application that manage calls through [[CAF_Call_interface]] is able to deal with call legs re-synchronization.		Since the [[Toolpack]] framework has been designed for HA ([[High_Availability_Overview]]), it's mandatory that an application that manage calls through [[CAF_Call_interface]] is able to deal with call legs re-synchronization.

	The current page contains an overview of how re-synchronization works. For more details, please refer to the following page:		The current page contains an overview of how re-synchronization works. For more details, please refer to the following section of the this page:

	[[CAF:_Working_With_Caf_Call_Legs#Re-synchronizing_with_toolpack_engine]]		[[CAF:_Working_With_Caf_Call_Legs#Re-synchronizing_with_toolpack_engine]]

Abrassard: /* Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds */

2012-10-19T11:55:29Z

Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds

← Older revision		Revision as of 07:55, 19 October 2012
Line 94:		Line 94:
	** ''OnCmcLibReady()''		** ''OnCmcLibReady()''

	=== Scenario 3: CAF application is restarted		=== Scenario 3: CAF application is restarted ===
	This is exactly same scenario as the end of Scenario 2 after .		This is exactly same scenario as the end of Scenario 2 after toolpack_engine pushes information to CAF library.

	= For more information... =		= For more information... =

Abrassard: /* Example scenarios */

2012-10-19T11:55:04Z

Example scenarios

@@ Line 29: / Line 29: @@
 == Example scenarios ==
 In all the scenarios below, let's consider the following situation:
+* Leg-A:   Ringing
-In this situation, the CAF application was restarted (on purpose, or after a crash). It does a cold start up, without any call leg contexts.
+=== Scenario 2: toolpack_engine stopped (disconnected) for more than 10 seconds ===
 = For more information... =

← Older revision		Revision as of 10:28, 6 September 2022
Line 1:		Line 1:
			{{DISPLAYTITLE:CAF: Call Legs Resync}}
	= Call Legs Resynchronization =		= Call Legs Resynchronization =
	Since the [[Toolpack]] framework has been designed for HA ([[High_Availability_Overview]]), it's mandatory that an application that ~~manage~~ calls through [[CAF_Call_interface]] is able to deal with call legs re-synchronization.		Since the [[Toolpack]] framework has been designed for HA ([[High_Availability_Overview]]), it's mandatory that an application that manages calls through [[CAF_Call_interface]] is able to deal with call legs re-synchronization.

	~~The current page~~ contains an overview of how ~~re-synchronization~~ works. For more details, please refer to the following section ~~of the this page~~:		This article contains an overview of how resynchronization works. For more details, please refer to the following section:

	[[CAF:_Working_With_Caf_Call_Legs#Re-synchronizing_with_toolpack_engine]]		[[CAF:_Working_With_Caf_Call_Legs#Re-synchronizing_with_toolpack_engine]]

	== Situations where call leg resynchronization is required ==		== Situations where call leg resynchronization is required ==
	Call legs re-synchronization is required whenever the CAF application ~~looses~~ communication with [[Toolpack_Application:toolpack_engine\|toolpack_engine]]:		Call legs re-synchronization is required whenever the CAF application loses communication with [[Toolpack_Application:toolpack_engine\|toolpack_engine]]:
	* The CAF application was restarted		* The CAF application was restarted
	* The [[Toolpack_Application:toolpack_engine\|toolpack_engine]] was restarted		* The [[Toolpack_Application:toolpack_engine\|toolpack_engine]] was restarted
Line 14:		Line 15:
	== General principles of call legs re-sync ==		== General principles of call legs re-sync ==
	=== Toolpack Engine ===		=== Toolpack Engine ===
	The [[Toolpack_Application:toolpack_engine\|toolpack_engine]] application, when restarted, will re-build ~~it's~~ call leg contexts by querying information on the TMedia Units.		The [[Toolpack_Application:toolpack_engine\|toolpack_engine]] application, when restarted, will re-build its call leg contexts by querying information on the TMedia Units.
	* Transient calls (not yet answered) will be dropped		* Transient calls (not yet answered) will be dropped
	* Terminating calls will be dropped		* Terminating calls will be dropped
	* Active (answered) calls will be ~~re-build~~ like they were before [[Toolpack_Application:toolpack_engine\|toolpack_engine]] was restarted		* Active (answered) calls will be rebuilt like they were before [[Toolpack_Application:toolpack_engine\|toolpack_engine]] was restarted

	=== CAF application ===		=== CAF application ===
	The CAF call control application that was disconnected from [[Toolpack_Application:toolpack_engine\|toolpack_engine]] will update (or ~~re-build~~) ~~it's~~ call leg contexts by getting information automatically pushed by [[Toolpack_Application:toolpack_engine\|toolpack_engine]] upon ~~re-connection~~.		The CAF call control application that was disconnected from [[Toolpack_Application:toolpack_engine\|toolpack_engine]] will update (or rebuild) its call leg contexts by getting information automatically pushed by [[Toolpack_Application:toolpack_engine\|toolpack_engine]] upon reconnection.

	All active (answered) calls will be ~~re-synchronized~~ from [[Toolpack_Application:toolpack_engine\|toolpack_engine]].		All active (answered) calls will be resynchronized from [[Toolpack_Application:toolpack_engine\|toolpack_engine]].
	* Calls already known by the application will remain valid		* Calls already known by the application will remain valid
	* Calls unknown by the application will be ~~re-constructed~~ (or refused): ''OnCallLegSync'', ''OnLinkSync''		* Calls unknown by the application will be reconstructed (or refused): ''OnCallLegSync'', ''OnLinkSync''
	* Calls known by the application, but no more present in [[Toolpack_Application:toolpack_engine\|toolpack_engine]] are terminated: ''OnCallLegTerminated''		* Calls known by the application, but no more present in [[Toolpack_Application:toolpack_engine\|toolpack_engine]] are terminated: ''OnCallLegTerminated''

Line 107:		Line 108:
	** Destructor of all call flows is called		** Destructor of all call flows is called
	* When the application is restarted		* When the application is restarted
	** => This is exactly same scenario as the end of Scenario 2 after step 'toolpack_engine pushes information to CAF library'.		** => This is exactly the same scenario as the end of Scenario 2 after step 'toolpack_engine pushes information to CAF library'.

	= For more information... =		= For more information... =