External module command flow - Revision history

Vladimir Latyshev at 15:19, 24 March 2016

2016-03-24T15:19:53Z

Dana: /* Format of commands and notifications */

2015-02-06T08:26:36Z

‎Format of commands and notifications

Dana: /* Format of commands and notifications */

2015-02-06T08:24:11Z

‎Format of commands and notifications

Dana: /* Format of commands and notifications */

2015-02-06T08:23:02Z

‎Format of commands and notifications

Dana at 08:19, 6 February 2015

2015-02-06T08:19:24Z

Dana at 08:18, 6 February 2015

2015-02-06T08:18:34Z

Monica: /* Example */

2013-11-04T11:16:30Z

‎Example

Monica: /* Example */

2013-08-19T07:31:02Z

‎Example

Monica at 08:22, 16 August 2013

2013-08-16T08:22:52Z

Monica at 08:21, 16 August 2013

2013-08-16T08:21:10Z

@@ Line 174: / Line 174: @@
 timeout (int) - Timeout in milliseconds for answering to messages<br/>
 timebomb (bool) - Terminate this module instance if a timeout occured<br/>
 setdata (bool) - Attach channel pointer as user data to generated messages<br/>
 reenter (bool) - If this module is allowed to handle messages generated by itself<br/>

@@ Line 66: / Line 66: @@
 <name> - name of the message<br/>
 <retvalue> - default textual return value of the message<br/>
-<key>=<value> - enumeration of the key-value pairs of the message<br/>
+<key>=<value> - enumeration of the key-value pairs of the message
 <br/>
@@ Line 90: / Line 90: @@
 <name> - name of the messages for that a handler should be installed<br/>
 <filter-name> - name of a variable the handler will filter<br/>
-<filter-value> - matching value for the filtered variable<br/>
+<filter-value> - matching value for the filtered variable
 <br/>

@@ Line 67: / Line 67: @@
 <retvalue> - default textual return value of the message<br/>
 <key>=<value> - enumeration of the key-value pairs of the message<br/>
@@ Line 78: / Line 79: @@
 <retvalue> - textual return value of the message<br/>
 <key>=<value> - key-value pairs of parameters to the message.
@@ Line 108: / Line 110: @@
 The answer to the uninstall request is delivered asynchronously (see below).<br/>
 <name> - name of the message handler thst should be uninstalled
@@ Line 118: / Line 121: @@
 <success> - boolean ("true" or "false") success of operation
 <br/>
 '''Keyword: %%>watch'''<br/>
@@ Line 126: / Line 130: @@
 <name> - name of the messages for that a watcher should be installed
 <br/>
 '''Keyword: %%<watch'''<br/>
@@ Line 134: / Line 139: @@
 <success> - boolean ("true" or "false") success of operation
 <br/>
 '''Keyword: %%>unwatch'''<br/>
@@ Line 142: / Line 148: @@
 <name> - name of the message watcher thst should be uninstalled
 <br/>
 '''Keyword: %%<unwatch'''<br/>
@@ Line 150: / Line 157: @@
 <success> - boolean ("true" or "false") success of operation
 <br/>
 '''Keyword: %%>setlocal'''<br/>
@@ Line 188: / Line 196: @@
 config.<section>.<key> (readonly) - Content of key= in [section] of main config file (yate.conf, yate-qt4.conf)
 <br/>
 '''Keyword: %%<setlocal'''<br/>
@@ Line 197: / Line 206: @@
 <success> - boolean ("true" or "false") success of operation
 <br/>
 '''Keyword: %%>output'''<br/>
@@ Line 204: / Line 214: @@
 This is the proper way of logging messages for programs that connect to the socket interface as they may not have the standard error redirected.
 <br/>
 '''Keyword: %%>connect'''<br/>

@@ Line 23: / Line 23: @@
 Any value that contains special characters (ASCII code lower than 32) MUST have them converted to %<upcode> where <upcode> is the character with a numeric value equal with 64 + original ASCII code. The % character itself MUST be converted to a special %% representation. Characters with codes higher than 32 (except %) SHOULD not be escaped but may be so. A %-escaped code may be received instead of an unescaped character anywhere except in the initial keyword or the delimiting colon (:) characters. Anywhere in the line except the initial keyword a % character not followed by a character with a numeric value higher than 64 (40H, 0x40, '@') or another % is an error.
 <br/>
 '''Special Keyword: Error in'''<br/>
@@ Line 31: / Line 32: @@
 The external module SHOULD NOT send anything back to Yate in response to such a notification as it can result in an infinite loop.
 <br/>
 '''Keyword: %%>message'''<br/>
@@ Line 42: / Line 44: @@
 <key>=<value> - enumeration of the key-value pairs of the message
 <br/>
 '''Keyword: %%<message'''<br/>
@@ Line 53: / Line 56: @@
 <key>=<value> - new key-value pairs to set in the message; to delete the key-value pair provide just a key name with no equal sign or value
 <br/>
 '''Keyword: %%>message'''<br/>
@@ Line 63: / Line 67: @@
 <retvalue> - default textual return value of the message<br/>
 <key>=<value> - enumeration of the key-value pairs of the message<br/>
 '''Keyword: %%<message'''<br/>
@@ Line 73: / Line 78: @@
 <retvalue> - textual return value of the message<br/>
 <key>=<value> - key-value pairs of parameters to the message.
-<br/>
 '''Keyword: %%>install'''<br/>
@@ Line 85: / Line 90: @@
 <filter-value> - matching value for the filtered variable<br/>
 <br/>
 '''Keyword: %%<install'''<br/>
@@ Line 94: / Line 100: @@
 <success> - boolean ("true" or "false") success of operation
 <br/>
 '''Keyword: %%>uninstall'''<br/>
@@ Line 101: / Line 108: @@
 The answer to the uninstall request is delivered asynchronously (see below).<br/>
 <name> - name of the message handler thst should be uninstalled
-<br/>
 '''Keyword: %%<uninstall'''<br/>

@@ Line 56: / Line 56: @@
 '''Keyword: %%>message'''<br/>
 %%>message:<id>:<time>:<name>:<retvalue>[:<key>=<value>...]<br/>
-Direction: Application to engine<br/>
+'''Direction: Application to engine'''<br/>
 This line is sent by the application to the engine to ask it to process a message. The answer to such a message is delivered asynchronously (see below).<br/>
 <id> - obscure unique message ID string generated by the application<br/>

← Older revision		Revision as of 11:16, 4 November 2013
Line 261:		Line 261:
	* [[External Module]]		* [[External Module]]
	* [[Yate's PHP library]]		* [[Yate's PHP library]]
		+
		+	[[Category:Extmodule]] [[Category:External module]] [[Category:Programmers]]

← Older revision		Revision as of 07:31, 19 August 2013
Line 257:		Line 257:
	The engine releases the message 234479244 (as if "false" was returned) and		The engine releases the message 234479244 (as if "false" was returned) and
	uninstalls the remaining "engine.timer" handler		uninstalls the remaining "engine.timer" handler
		+
		+	'''See also'''
		+	* [[External Module]]
		+	* [[Yate's PHP library]]

← Older revision		Revision as of 08:22, 16 August 2013
Line 1:		Line 1:
−	This document describes the external module command flow - the protocol used by [[External Module\|extmodule]] to communicate with external scripts. Look in share/scripts directory from yate's sources to find libraries in various languages that implement this protocol.	+	This document describes the external module command flow - the protocol used by [[External Module\|extmodule]] to communicate with external scripts. <br/>Look in share/scripts directory from yate's sources to find libraries in various languages that implement this protocol.

	===File handles used===		===File handles used===

← Older revision		Revision as of 08:21, 16 August 2013
Line 1:		Line 1:
−	This document describes the external module command flow - the protocol used by [[~~Externa~~ Module\|extmodule]] to communicate with external scripts. Look in share/scripts directory from yate's sources to find libraries in various languages that implement this protocol.	+	This document describes the external module command flow - the protocol used by [[External Module\|extmodule]] to communicate with external scripts. Look in share/scripts directory from yate's sources to find libraries in various languages that implement this protocol.

	===File handles used===		===File handles used===