Documentation/Messaging - Revision history

Sascha at 11:19, 28 November 2011

2011-11-28T11:19:36Z

← Older revision		Revision as of 11:19, 28 November 2011
Line 1:		Line 1:
			This document was written during the Georgetown Hackfest. In the meantime, a message broker solution has been implemented in the CTK Plugin Framework. A [[Documentation/CTK_Plugin_EventAdmin_local \| in-process implementation]] is available and an [[Documentation/CTK_Plugin_EventAdmin_remote \| out-of-process implementation]] is available for experimentation.

	=Use cases=		=Use cases=
	==Event Management ==		==Event Management ==

PatrickCheng: /* Implementation */

2010-05-28T12:55:53Z

Implementation

← Older revision		Revision as of 12:55, 28 May 2010
Line 26:		Line 26:
	#* [http://www.zeromq.org/ ZeroMQ] is a small and fast implementation of the [http://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol Advanced Message Queuing Protocol] under the LGPL license		#* [http://www.zeromq.org/ ZeroMQ] is a small and fast implementation of the [http://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol Advanced Message Queuing Protocol] under the LGPL license
	#* It supports both synchronous and asynchronous messaging mode		#* It supports both synchronous and asynchronous messaging mode
	#* It supportsTCP, ~~Multicast~~/PGM, ~~Inter~~-process, and inter-thread transportation		#* It supportsTCP, multicast/PGM, inter-process, and inter-thread transportation
	#* CMake version of library can be found here http://github.com/PatrickCheng/zeromq2		#* CMake version of library can be found here http://github.com/PatrickCheng/zeromq2
	#* API can be found here http://api.zeromq.org/zmq.html		#* API can be found here http://api.zeromq.org/zmq.html

PatrickCheng: /* Solution */

2010-05-28T00:38:18Z

Solution

← Older revision		Revision as of 00:38, 28 May 2010
Line 14:		Line 14:

	# Use [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration		# Use [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration
	[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]		{\|
	[[File:Messave bus and pub&sub.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC17158.gif]]		\|[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]
			\|[[File:Messave bus and pub&sub.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC17158.gif]]
			\|}

	=Implementation=		=Implementation=

PatrickCheng at 00:36, 28 May 2010

2010-05-28T00:36:07Z

← Older revision		Revision as of 00:36, 28 May 2010
Line 5:		Line 5:
	# Temporal calibration: Different components have different update frequency, a centralized manager can be used to filter UpdateEvents, so the whole system is updating at the same frequency		# Temporal calibration: Different components have different update frequency, a centralized manager can be used to filter UpdateEvents, so the whole system is updating at the same frequency

	~~[[File:Amqp.jpg\|thumb\|none\|300px\|<big>AMQP model</big><br>Source: http://upload.wikimedia.org/wikipedia/en/9/9d/The-amqp-model-for-wikipedia.svg]]~~

	==System Integration==		==System Integration==
	Different system/application have different data format or are running on different physical devices. A event bus can be used for system integration		Different system/application have different data format or are running on different physical devices. A event bus can be used for system integration

	=~~Implementation~~=		=Solution=
	# Use[http://msdn.microsoft.com/en-us/library/ff648849(v=pandp.10).aspx Message Broker] for event management		# Use[http://msdn.microsoft.com/en-us/library/ff648849(v=pandp.10).aspx Message Broker] for event management
			[[File:Amqp.jpg\|thumb\|none\|300px\|<big>AMQP model</big><br>Source: http://upload.wikimedia.org/wikipedia/en/9/9d/The-amqp-model-for-wikipedia.svg]]

	# Use [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration		# Use [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration
			[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]
			[[File:Messave bus and pub&sub.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC17158.gif]]

			=Implementation=
	# Message layer: [http://www.na-mic.org/Wiki/index.php/OpenIGTLink OpenIGTLink]		# Message layer: [http://www.na-mic.org/Wiki/index.php/OpenIGTLink OpenIGTLink]
	#* OpenIGTLink defines many common data format and message structure		#* OpenIGTLink defines many common data format and message structure
Line 22:		Line 27:
	#* CMake version of library can be found here http://github.com/PatrickCheng/zeromq2		#* CMake version of library can be found here http://github.com/PatrickCheng/zeromq2
	#* API can be found here http://api.zeromq.org/zmq.html		#* API can be found here http://api.zeromq.org/zmq.html

	~~[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]~~


	~~[[File:Messave bus and pub&sub.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC17158.gif]]~~

PatrickCheng: /* Implementation */

2010-05-28T00:34:03Z

Implementation

← Older revision		Revision as of 00:34, 28 May 2010
Line 13:		Line 13:
	# Use[http://msdn.microsoft.com/en-us/library/ff648849(v=pandp.10).aspx Message Broker] for event management		# Use[http://msdn.microsoft.com/en-us/library/ff648849(v=pandp.10).aspx Message Broker] for event management
	# Use [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration		# Use [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration
	#* Message layer: [http://www.na-mic.org/Wiki/index.php/OpenIGTLink OpenIGTLink]		# Message layer: [http://www.na-mic.org/Wiki/index.php/OpenIGTLink OpenIGTLink]
	#** OpenIGTLink defines many common data format and message structure		#* OpenIGTLink defines many common data format and message structure
	#** It has plain vanilla socket support, might switch to ZeroMQ for transportation		#* It has plain vanilla socket support, might switch to ZeroMQ for transportation
	#* Transportation layer abstraction: [http://www.zeromq.org/ ZeroMQ]		# Transportation layer abstraction: [http://www.zeromq.org/ ZeroMQ]
	#** [http://www.zeromq.org/ ZeroMQ] is a small and fast implementation of the [http://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol Advanced Message Queuing Protocol] under the LGPL license		#* [http://www.zeromq.org/ ZeroMQ] is a small and fast implementation of the [http://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol Advanced Message Queuing Protocol] under the LGPL license
	#** It supports both synchronous and asynchronous messaging mode		#* It supports both synchronous and asynchronous messaging mode
	#** It supportsTCP, Multicast/PGM, Inter-process, and inter-thread transportation		#* It supportsTCP, Multicast/PGM, Inter-process, and inter-thread transportation
	#** CMake version of library can be found here http://github.com/PatrickCheng/zeromq2		#* CMake version of library can be found here http://github.com/PatrickCheng/zeromq2
	#** API can be found here http://api.zeromq.org/zmq.html		#* API can be found here http://api.zeromq.org/zmq.html

	[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]		[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]

PatrickCheng: /* Event Management */

2010-05-28T00:33:25Z

Event Management

← Older revision		Revision as of 00:33, 28 May 2010
Line 2:		Line 2:
	==Event Management ==		==Event Management ==
	Each component/application generates many different types of events. A centralized event manager (Hub and Spoke) can be used to aggregate/dispatch events		Each component/application generates many different types of events. A centralized event manager (Hub and Spoke) can be used to aggregate/dispatch events
	* Synchronization: Window/Leveling events in one window should be synchronized across all viewer windows		# Synchronization: Window/Leveling events in one window should be synchronized across all viewer windows
	* Temporal calibration: Different components have different update frequency, a centralized manager can be used to filter UpdateEvents, so the whole system is updating at the same frequency		# Temporal calibration: Different components have different update frequency, a centralized manager can be used to filter UpdateEvents, so the whole system is updating at the same frequency

	[[File:Amqp.jpg\|thumb\|none\|300px\|<big>AMQP model</big><br>Source: http://upload.wikimedia.org/wikipedia/en/9/9d/The-amqp-model-for-wikipedia.svg]]		[[File:Amqp.jpg\|thumb\|none\|300px\|<big>AMQP model</big><br>Source: http://upload.wikimedia.org/wikipedia/en/9/9d/The-amqp-model-for-wikipedia.svg]]


	==System Integration==		==System Integration==

PatrickCheng: /* Implementation */

2010-05-28T00:32:46Z

Implementation

← Older revision		Revision as of 00:32, 28 May 2010
Line 12:		Line 12:

	=Implementation=		=Implementation=
	~~Using~~ [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration		# Use[http://msdn.microsoft.com/en-us/library/ff648849(v=pandp.10).aspx Message Broker] for event management
	* OpenIGTLink ~~can be used to define the~~ common message ~~schema~~, ~~and~~ ZeroMQ ~~can be used to handle the~~ transportation layer abstraction		# Use [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration
	* [http://www.zeromq.org/ ZeroMQ] is a small and fast implementation of the [http://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol Advanced Message Queuing Protocol] under the LGPL license		#* Message layer: [http://www.na-mic.org/Wiki/index.php/OpenIGTLink OpenIGTLink]
	** It supports both synchronous and asynchronous messaging mode		#** OpenIGTLink defines many common data format and message structure
	** It supportsTCP, Multicast/PGM, Inter-process, and inter-thread transportation		#** It has plain vanilla socket support, might switch to ZeroMQ for transportation
	** CMake version of library can be found here http://github.com/PatrickCheng/zeromq2		#* Transportation layer abstraction: [http://www.zeromq.org/ ZeroMQ]
	** API can be found here http://api.zeromq.org/zmq.html		#** [http://www.zeromq.org/ ZeroMQ] is a small and fast implementation of the [http://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol Advanced Message Queuing Protocol] under the LGPL license
			#** It supports both synchronous and asynchronous messaging mode
			#** It supportsTCP, Multicast/PGM, Inter-process, and inter-thread transportation
			#** CMake version of library can be found here http://github.com/PatrickCheng/zeromq2
			#** API can be found here http://api.zeromq.org/zmq.html

	[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]		[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]

PatrickCheng at 00:22, 28 May 2010

2010-05-28T00:22:54Z

← Older revision		Revision as of 00:22, 28 May 2010
Line 5:		Line 5:
	* Temporal calibration: Different components have different update frequency, a centralized manager can be used to filter UpdateEvents, so the whole system is updating at the same frequency		* Temporal calibration: Different components have different update frequency, a centralized manager can be used to filter UpdateEvents, so the whole system is updating at the same frequency

	[[File:Amqp.jpg\|thumb\|300px\|<big>AMQP model</big><br>Source: http://upload.wikimedia.org/wikipedia/en/9/9d/The-amqp-model-for-wikipedia.svg]]		[[File:Amqp.jpg\|thumb\|none\|300px\|<big>AMQP model</big><br>Source: http://upload.wikimedia.org/wikipedia/en/9/9d/The-amqp-model-for-wikipedia.svg]]


Line 19:		Line 19:
	** CMake version of library can be found here http://github.com/PatrickCheng/zeromq2		** CMake version of library can be found here http://github.com/PatrickCheng/zeromq2
	** API can be found here http://api.zeromq.org/zmq.html		** API can be found here http://api.zeromq.org/zmq.html

			[[File:Message bus.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC97398.gif]]


			[[File:Messave bus and pub&sub.gif\|thumb\|none\|300px\|<big>Message Bus</big><br>Source: http://i.msdn.microsoft.com/dynimg/IC17158.gif]]

PatrickCheng at 00:15, 28 May 2010

2010-05-28T00:15:07Z

← Older revision		Revision as of 00:15, 28 May 2010
Line 1:		Line 1:
			=Use cases=
			==Event Management ==
			Each component/application generates many different types of events. A centralized event manager (Hub and Spoke) can be used to aggregate/dispatch events
			* Synchronization: Window/Leveling events in one window should be synchronized across all viewer windows
			* Temporal calibration: Different components have different update frequency, a centralized manager can be used to filter UpdateEvents, so the whole system is updating at the same frequency

			[[File:Amqp.jpg\|thumb\|300px\|<big>AMQP model</big><br>Source: http://upload.wikimedia.org/wikipedia/en/9/9d/The-amqp-model-for-wikipedia.svg]]


			==System Integration==
			Different system/application have different data format or are running on different physical devices. A event bus can be used for system integration

			=Implementation=
	Using [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration		Using [http://msdn.microsoft.com/en-us/library/ff647328.aspx Message Bus] and [http://msdn.microsoft.com/en-us/library/ff649664(v=pandp.10).aspx Publisher/Subscriber] design pattern for system integration
	* OpenIGTLink can be used to define the common message schema, and ZeroMQ can be used to handle the transportation layer abstraction		* OpenIGTLink can be used to define the common message schema, and ZeroMQ can be used to handle the transportation layer abstraction

PatrickCheng at 22:24, 27 May 2010

2010-05-27T22:24:30Z

← Older revision		Revision as of 22:24, 27 May 2010
Line 4:		Line 4:
	** It supports both synchronous and asynchronous messaging mode		** It supports both synchronous and asynchronous messaging mode
	** It supportsTCP, Multicast/PGM, Inter-process, and inter-thread transportation		** It supportsTCP, Multicast/PGM, Inter-process, and inter-thread transportation
	** CMake version of library can be found here [http://github.com/PatrickCheng/zeromq2 ~~ZeroMQ]~~		** CMake version of library can be found here http://github.com/PatrickCheng/zeromq2
	** API can be found here http://api.zeromq.org/zmq.html		** API can be found here http://api.zeromq.org/zmq.html