Browse code

evrexec: documentation for rpc command evrexec.run

Daniel-Constantin Mierla authored on 22/02/2019 11:16:40
Showing 1 changed files
... ...
@@ -123,5 +123,43 @@ event_route[evrexec:timer] {
123 123
 	</section>
124 124
 	</section>
125 125
 
126
+	<section>
127
+	<title>RPC Commands</title>
128
+	<section id="evrexec.r.run">
129
+		<title>evrexec.run</title>
130
+		<para>
131
+		Run an event_route block or a KEMI function upon an RPC command.
132
+		</para>
133
+		<para>
134
+		Name: <emphasis>evroute.run</emphasis>
135
+		</para>
136
+		<para>Parameters:
137
+		<itemizedlist>
138
+			<listitem>
139
+			<para>evname</para> - the name of the event route block or the KEMI
140
+			function.
141
+			</listitem>
142
+			<listitem>
143
+			<para>evdata</para> - (optional) - arbitrary data passed as a string,
144
+			which is made available inside event route block as $evr(data).
145
+			</listitem>
146
+		</itemizedlist>
147
+		</para>
148
+
149
+		<para>
150
+		RPC Command Format:
151
+		</para>
152
+		<programlisting  format="linespecific">
153
+...
154
+event_route[evrexec:test] {
155
+   xlog("rpc command data: $evr(data)\n");
156
+}
157
+...
158
+kamctl rpc evroute.run evroute:test
159
+kamctl rpc evroute.run evroute:test mydata
160
+...
161
+		</programlisting>
162
+	</section>
163
+	</section>
126 164
 </chapter>
127 165