Ipc - Revision history

Boiarino: /* General info */

2018-01-08T18:08:38Z

General info

← Older revision		Revision as of 14:08, 8 January 2018
Line 33:		Line 33:
	2. '''json message''' - in that form message contains the list of json strings in following form:		2. '''json message''' - in that form message contains the list of json strings in following form:

	[{json1},{json2},..]		{....} - json
			{bla:[{json1},{json2},..]} - list of jsons

	and message does NOT contains anything else.		and message does NOT contains anything else.
Line 79:		Line 80:
	server.Close();		server.Close();
	}		}



	== MessageActionControl.h ==		== MessageActionControl.h ==

Boiarino at 13:32, 6 January 2018

2018-01-06T13:32:45Z

← Older revision		Revision as of 09:32, 6 January 2018
Line 58:		Line 58:
	server.AddRecvTopic(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"test");		server.AddRecvTopic(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"test");

	// ~~connect~~ to server		// open connection to server
	server.~~Connect~~();		server.Open();

	// create listeners		// create listeners
Line 66:		Line 66:

	// add listeners to receiver's list		// add listeners to receiver's list
	server.~~AddListener~~(control);		server.AddCallback(control);
	server.~~AddListener~~(xxxx);		server.AddCallback(xxxx);

	// send message		// send message
Line 76:		Line 76:
	server << clrm << ...stuff... << SetTopic("AA.BB.CC.DD") << endm;		server << clrm << ...stuff... << SetTopic("AA.BB.CC.DD") << endm;

	// ~~disconnect from~~ server		// close connection to server
	server.~~Disconnect~~();		server.Close();
	}		}



	== MessageActionControl.h ==		== MessageActionControl.h ==

Boiarino: /* General info */

2018-01-06T04:07:06Z

General info

← Older revision		Revision as of 00:07, 6 January 2018
Line 72:		Line 72:
	server << clrm << ...stuff... << endm;		server << clrm << ...stuff... << endm;

	// send message to different topic; it will overrule topic list set by 'AddSendTopic()' ONLY for this particular message, all following messages will use topic set by 'AddSendTopic()', unless 'SetTopic()' modifier is used again		// send message to different topic; it will overrule topic list set by 'AddSendTopic()' ONLY for this particular message,
			// all following messages will use topic set by 'AddSendTopic()', unless 'SetTopic()' modifier is used again
	server << clrm << ...stuff... << SetTopic("AA.BB.CC.DD") << endm;		server << clrm << ...stuff... << SetTopic("AA.BB.CC.DD") << endm;

Boiarino: /* General info */

2018-01-06T04:06:09Z

General info

← Older revision		Revision as of 00:06, 6 January 2018
Line 1:		Line 1:
	== General info ==		== General info ==

	Interprocess communication in Hall B is based on package located in $~~CLON~~/src/ipc. Currently it is based on ActiveMQ, which can be replaced with another messager if necessary~~, for example jlab-developed xMsg~~. Switching between messagers is done by changing $~~CLON~~/src/Makefile.include and recompiling entire $CLON ~~area~~. ActiveMQ or any other messager must be installed in /usr/local/src area.		Interprocess communication in Hall B is based on package located in $CODA/src/ipc. Currently it is based on ActiveMQ, which can be replaced with another messager if necessary. Switching between messagers shell be done by changing $CODA/src/Makefile.include and recompiling entire $CODA and $CLON areas. ActiveMQ or any other messager must be installed in /usr/local/src area.

	Top level classes can be found in $~~CLON~~/src/ipc/ipc.s/ipc_lib.h, test program is $~~CLON~~/src/ipc/main/ipc_client.cc.		Top level classes can be found in $CODA/src/ipc/ipc.s/ipc_lib.h, test program is $CODA/src/ipc/main/ipc_client.cc. In case of switching to another messager, top level API in ipc_lib.h should remain the same to avoid changes in user code, meaning new ipc_lib.h must be written to support another messager.

	Sender and receiver subscribes to the lists of 4-field topics, different for sender and receiver. Topics in the list are separated by commas (','), for example for 2 topics:		Sender and receiver subscribes to the lists of 4-field topics, different for sender and receiver. Topics in the list are separated by commas (','), for example for 2 topics:
Line 16:		Line 16:
	TOPIC14 - message subclass, sometimes unique name of sender (program name), or anything else		TOPIC14 - message subclass, sometimes unique name of sender (program name), or anything else

	~~Every message starts from message 'header' in a form of character string~~, ~~with two possible forms:~~		If no topics provided, it assumes "EXPID.SESSION.." so all messages will be sent to EXPID and SESSION and processed.

	1. '''non-json''' - in that form message contains 'header' and 'body'. Message 'header' is the character string containing fields separated by ':', usually with following meaning:		Every message starts from message 'header' in a form of character string, with two possible options:

			1. '''non-json message''' - in that form message contains 'header' and 'body'. Message 'header' is the character string containing fields separated by ':', usually with following meaning:

	"FORMAT:FORMAT1:FORMAT2:....."		"FORMAT:FORMAT1:FORMAT2:....."
Line 29:		Line 31:
	Message 'body' contains the elements or an arrays of elements in any format supported by ActiveMQ.		Message 'body' contains the elements or an arrays of elements in any format supported by ActiveMQ.

	2. '''json''' - in that form message contains the list of json strings in following form:		2. '''json message''' - in that form message contains the list of json strings in following form:

	[{json1},{json2},..]		[{json1},{json2},..]
Line 70:		Line 72:
	server << clrm << ...stuff... << endm;		server << clrm << ...stuff... << endm;

	// send message to different topic; it will overrule topic list set by '~~SendTopic~~' ONLY for this particular message		// send message to different topic; it will overrule topic list set by 'AddSendTopic()' ONLY for this particular message, all following messages will use topic set by 'AddSendTopic()', unless 'SetTopic()' modifier is used again
	server << clrm << ...stuff... << SetTopic("AA.BB.CC.DD") << endm;		server << clrm << ...stuff... << SetTopic("AA.BB.CC.DD") << endm;

Line 76:		Line 78:
	server.Disconnect();		server.Disconnect();
	}		}


	== MessageActionControl.h ==		== MessageActionControl.h ==

Boiarino at 03:55, 6 January 2018

2018-01-06T03:55:27Z

← Older revision		Revision as of 23:55, 5 January 2018
Line 50:		Line 50:
	{		{
	// add topic(s) to sender's subscribe list; can be overruled by SetTopic() modifier (see below)		// add topic(s) to sender's subscribe list; can be overruled by SetTopic() modifier (see below)
	server.~~SendTopic~~(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"server");		server.AddSendTopic(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"server");

	// add topic(s) to receiver's subscribe list		// add topic(s) to receiver's subscribe list
	server.~~RecvTopic~~(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"server");		server.AddRecvTopic(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"server");
	server.~~RecvTopic~~(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"test");		server.AddRecvTopic(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"test");

	// connect to server		// connect to server
Line 64:		Line 64:

	// add listeners to receiver's list		// add listeners to receiver's list
	server.~~RecvListener~~(control);		server.AddListener(control);
	server.~~RecvListener~~(xxxx);		server.AddListener(xxxx);

	// send message		// send message
Line 76:		Line 76:
	server.Disconnect();		server.Disconnect();
	}		}


	== MessageActionControl.h ==		== MessageActionControl.h ==
Line 81:		Line 82:
	Sends commands and receives status. Command message sent by program 'myname' must has following format:		Sends commands and receives status. Command message sent by program 'myname' must has following format:

	server.~~init~~(getenv("EXPID"), getenv("SESSION"), "control", destination);		server.AddSendTopic(getenv("EXPID"), getenv("SESSION"), "control", destination);

	server << clrm << "command:myname" << "quit" << endm; // request to quit		server << clrm << "command:myname" << "quit" << endm; // request to quit
	server << clrm << "command:myname" << "status" << endm; // request for status		server << clrm << "command:myname" << "status" << endm; // request for status
Line 91:		Line 93:
	server << clrm << "statistics:myname" << nelem << elem1 << elem2 << .. << endm;		server << clrm << "statistics:myname" << nelem << elem1 << elem2 << .. << endm;

	In examples above message header contains two parts: message format and sender name, that header form shell be typically used for all messages in ~~CLAS12~~.		In examples above message header contains two parts: message format and sender name, that header form shell be typically used for all non-json messages in HallB.


	== MessageActionEPICS.h ==		== MessageActionEPICS.h ==

	Sends and receives EPICS messages. Message sent by program 'myname' must has following format:		Sends and receives non-json EPICS messages. Message sent by program 'myname' must has following format:

			server.AddSendTopic(getenv("EXPID"), getenv("SESSION"), "epics", destination);

	~~server.init(getenv("EXPID"), getenv("SESSION"), "epics", destination);~~		server << clrm << "epics" << "channel_name" << "channel_type" << Nelements << element1 << element2 << ... << endm;
	server << clrm << "epics" ~~<< "myname" << "hostname" << "username" << unix_time~~ << "channel_name" << "channel_type" << Nelements << element1 << element2 << ... << endm;

	"channel_type" can be one of following:		"channel_type" can be one of following:

Boiarino: /* General info */

2018-01-06T03:49:39Z

General info

← Older revision		Revision as of 23:49, 5 January 2018
Line 5:		Line 5:
	Top level classes can be found in $CLON/src/ipc/ipc.s/ipc_lib.h, test program is $CLON/src/ipc/main/ipc_client.cc.		Top level classes can be found in $CLON/src/ipc/ipc.s/ipc_lib.h, test program is $CLON/src/ipc/main/ipc_client.cc.

	Sender subscribes to the 4-field ~~topic~~		Sender and receiver subscribes to the lists of 4-field topics, different for sender and receiver. Topics in the list are separated by commas (','), for example for 2 topics:

	"~~TOPIC1"~~.~~"TOPIC2"~~.~~"TOPIC3"~~.~~"TOPIC4~~"		"TOPIC11.TOPIC12.TOPIC13.TOPIC14, TOPIC21.TOPIC22.TOPIC23.TOPIC24"

	~~and start message from message header in a form of character string~~		Every topic contains 4 fields separated by dots ('.'). Following convention is adopted for HallB messaging (defaults are NULL or '*'):

	(char *)"~~FORMAT:TOPIC4:TOPIC3:TOPIC2:TOPIC1~~"		TOPIC11 - usually getenv("EXPID")
			TOPIC12 - usually getenv("SESSION")
			TOPIC13 - message class, for example 'control', 'epics', 'daq' etc
			TOPIC14 - message subclass, sometimes unique name of sender (program name), or anything else

	with ~~following format~~:		Every message starts from message 'header' in a form of character string, with two possible forms:

	~~Topic (defaults are NULL or~~ '*'):		1. '''non-json''' - in that form message contains 'header' and 'body'. Message 'header' is the character string containing fields separated by ':', usually with following meaning:

	~~TOPIC1 - usually getenv(~~"~~EXPID~~")		"FORMAT:FORMAT1:FORMAT2:....."
	~~TOPIC2 - usually getenv("SESSION")~~
	~~TOPIC3 - message class, for example 'control', 'epics', 'daq' etc~~
	~~TOPIC4 - unique name of sender, usually program name~~

	Message ~~header~~:		FORMAT - message format, for example 'cmd', 'runlog' etc, listener 'MessageActionXXXX.h' must be provided for every format
			FORMAT1 (optional, but preferrably sender program name)
			FORMAT2 (optional, if needed)
			.....

			Message 'body' contains the elements or an arrays of elements in any format supported by ActiveMQ.

			2. '''json''' - in that form message contains the list of json strings in following form:

			[{json1},{json2},..]

			and message does NOT contains anything else.

	~~FORMAT - message format, for example 'cmd', 'json' etc, 'MessageActionXXXX.h' must be provided for every format~~
	~~TOPIC4 (optional, but preferrably sender program name)~~
	~~TOPIC3 (optional, usually not used)~~
	~~TOPIC2 (optional, usually not used)~~
	~~TOPIC1 (optional, usually not used)~~


Line 43:		Line 49:
	main()		main()
	{		{
	// ~~following call sets~~ topic ~~for~~ sender ("~~par1.par2.par3.par4~~") ~~and receiver~~ ("~~par1.par2.par5.par6~~")		// add topic(s) to sender's subscribe list; can be overruled by SetTopic() modifier (see below)
	~~// 1st and 2nd params - usually EXPID and SESSION~~, ~~or EXPID and~~ NULL		server.SendTopic(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"server");
	~~// 3rd and 4th params - 'class' and 'destination' for sender only~~, ~~for example 'epics' and 'dbrouter'~~ (~~sending to class 'epics' and destination 'dbrouter'~~)
	// ~~5th and 6th params~~ (~~optional~~) ~~- 'class' and 'destination' for~~ receiver ~~only, for example~~ '~~epics' and '*' (listen for messages with class 'epics' and any destination)~~		// add topic(s) to receiver's subscribe list
	~~// for example:~~		server.RecvTopic(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"server");
	server.~~init~~(getenv("EXPID"), getenv("SESSION"), (char )"~~epics~~", (~~char )~~"~~dbrouter~~", (~~char )~~"~~epics~~", (char )"*");		server.RecvTopic(getenv("EXPID"), getenv("SESSION"), NULL, (char *)"test");

			// connect to server
			server.Connect();

			// create listeners
	MessageActionControl control = new MessageActionControl((char )"myname");		MessageActionControl control = new MessageActionControl((char )"myname");
	MessageActionXXXX *xxxx = new MessageActionXXXX();		MessageActionXXXX *xxxx = new MessageActionXXXX();

	server.~~addActionListener~~(control);		// add listeners to receiver's list
	server.~~addActionListener~~(xxxx);		server.RecvListener(control);
			server.RecvListener(xxxx);

			// send message
	server << clrm << ...stuff... << endm;		server << clrm << ...stuff... << endm;

	server.~~close~~();		// send message to different topic; it will overrule topic list set by 'SendTopic' ONLY for this particular message
			server << clrm << ...stuff... << SetTopic("AA.BB.CC.DD") << endm;

			// disconnect from server
			server.Disconnect();
	}		}


	== MessageActionControl.h ==		== MessageActionControl.h ==

Boiarino: /* MessageActionEPICS.h */

2017-09-29T19:58:31Z

MessageActionEPICS.h

← Older revision		Revision as of 15:58, 29 September 2017
Line 84:		Line 84:

	server.init(getenv("EXPID"), getenv("SESSION"), "epics", destination);		server.init(getenv("EXPID"), getenv("SESSION"), "epics", destination);
	server << clrm << "epics:myname" << "hostname" << "username" << unix_time << "channel_name" << "channel_type" << Nelements << element1 << element2 << ... << endm;		server << clrm << "epics" << "myname" << "hostname" << "username" << unix_time << "channel_name" << "channel_type" << Nelements << element1 << element2 << ... << endm;

	"channel_type" can be one of following:		"channel_type" can be one of following:

Boiarino: /* MessageActionEPICS.h */

2017-09-29T18:14:38Z

MessageActionEPICS.h

← Older revision		Revision as of 14:14, 29 September 2017
Line 95:		Line 95:
	float		float
	double		double
	string (NOTE: '~~Nelement~~' for 'string' can only be 1, array of strings not supported yet)		string (NOTE: 'Nelements' for 'string' can only be 1, array of strings not supported yet)

Boiarino: /* MessageActionEPICS.h */

2017-09-29T18:14:23Z

MessageActionEPICS.h

← Older revision		Revision as of 14:14, 29 September 2017
Line 81:		Line 81:
	== MessageActionEPICS.h ==		== MessageActionEPICS.h ==

	Sends ~~commands~~ and receives EPICS messages. ~~Command message~~ sent by program 'myname' must has following format:		Sends and receives EPICS messages. Message sent by program 'myname' must has following format:

	server.init(getenv("EXPID"), getenv("SESSION"), "epics", destination);		server.init(getenv("EXPID"), getenv("SESSION"), "epics", destination);

Boiarino at 18:13, 29 September 2017

2017-09-29T18:13:13Z

@@ Line 60: / Line 60: @@
     server.close();
+  }
 == MessageActionControl.h ==
@@ Line 76: / Line 77: @@
 In examples above message header contains two parts: message format and sender name, that header form shell be typically used for all messages in CLAS12.