RPC - Revision history

Zeyady98: /* Client */ update RPC examples path

2020-04-10T22:09:08Z

Client: update RPC examples path

Ptikhomirov: remove systemd service part as unsupported

2020-03-25T12:28:21Z

remove systemd service part as unsupported

Xemul: /* See also */

2016-09-17T15:57:49Z

Kir: Lots of English, formatting fixes etc

2015-04-06T16:14:35Z

Lots of English, formatting fixes etc

Show changes

Xemul: SWRK mode one level down

2015-04-02T14:52:29Z

SWRK mode one level down

Xemul: restructured to emphasize the swrk mode

2015-04-02T14:51:57Z

restructured to emphasize the swrk mode

Xemul: swrk is not legal

2015-04-02T14:49:04Z

swrk is not legal

Xemul: /* SWRK mode */

2015-03-26T15:08:01Z

SWRK mode

Xemul at 17:32, 3 March 2015

2015-03-03T17:32:18Z

Efiop: Mention cr_errno field.

2015-01-04T21:26:19Z

Mention cr_errno field.

@@ Line 239: / Line 239: @@
 Client, in its turn, must connect to service socket, send <code>criu_req</code> with request in it, and wait for a <code>criu_resp</code> with response.
-You can find examples of client programs in C and Python in test/rpc/.
+You can find examples of client programs in C and Python in test/others/rpc/.
 With RPC facilities one can perform a [[self dump]].

@@ Line 235: / Line 235: @@
 ; -v[N]
 : sets the log level
 === Client ===

@@ Line 264: / Line 264: @@
 == See also ==
+* [[CLI]]
 * [[C API]]
 [[Category: API]]

@@ Line 191: / Line 191: @@
 == Run ==
-== SWRK mode ==
+=== SWRK mode ===
 This mode turns on when one <code>fork() + exec()</code> CRIU with the <code>swrk</code> action and one more argument specifying the number of descriptor with ''seqpacket'' unix socket. With this CRIU works as service worker task accepting standard RPC requests via the mentioned socket and using one to do action scripts notifications and result reporting.

@@ Line 1: / Line 1: @@
-CRIU-RPC is a remote procedure call (RPC) protocol which uses Google Protocol Buffers to encode its calls. The requests are served by CRIU service launched with <code>criu service</code> command. It uses a SEQPACKET Unix domain socket listening at <code>/var/run/criu-service.socket</code> as a transport.
+CRIU-RPC is a remote procedure call (RPC) protocol which uses Google Protocol Buffers to encode its calls. The requests are served by CRIU when either launched in so called "swrk" mode or by service started with the <code>criu service</code> command. It uses a SEQPACKET Unix domain socket for transport. In case of standalone service it listens at <code>/var/run/criu-service.socket</code> as a transport.
 The criu_req/criu_resp are two main messages for requests/responses. They are to be used for transferring messages and needed to provide compatibility with an older versions of rpc. Field type in them ''must'' be set accordingly to type of request/response that is stored. Types of request/response are defined in enum criu_req_type. See the [[API compliance]] page for information what each option might mean.
@@ Line 5: / Line 5: @@
 == Protocol ==
-The protocol is simple -- client connect to service, send a ''criu_req'' message to server, server responds back with ''criu_resp'' and closes the socket. There are three exceptions from this rule, see below.
+The protocol is simple -- client sends a ''criu_req'' message to server, server responds back with ''criu_resp''. In most of the cases the socket gets closed, but there are three exceptions from this rule, see below.
 == Request ==
@@ Line 191: / Line 191: @@
 == Run ==
 === Server ===
 On a server side, CRIU creates SOCK_SEQPACKET Unix socket and listens for connections on it. After receiving criu_req, CRIU processes it, do what is requested and sends criu_resp with set request-specific criu_***_resp field back.
@@ Line 241: / Line 245: @@
 There's a [[C_API|library]] that implements simple wrappers on top of RPC.
 [[Category: API]]

@@ Line 245: / Line 245: @@
 {{Note|This mode is implemented by not yet standard. The API can change at any time}}
-This mode turns on when you <code>fork() + exec()</code> CRIU with the <code>swrk</code> action. With this CRIU works as service worker task accepting standard RPC requests.
 [[Category: API]]

← Older revision		Revision as of 17:32, 3 March 2015
Line 241:		Line 241:

	There's a [[C_API\|library]] that implements simple wrappers on top of RPC.		There's a [[C_API\|library]] that implements simple wrappers on top of RPC.
		+
		+	== SWRK mode ==
		+
		+	{{Note\|This mode is implemented by not yet standard. The API can change at any time}}
		+	This mode turns on when you <code>fork() + exec()</code> CRIU with the <code>swrk</code> action. With this CRIU works as service worker task accepting standard RPC requests.

	[[Category: API]]		[[Category: API]]

@@ Line 140: / Line 140: @@
 	optional criu_notify		notify		= 5;
 	optional criu_page_server_info	ps		= 6;
+}
 </pre>
-Field "success" reports result of processing request, while criu_***_resp store some request-specific information. The response type is set to the corresponding request type or to <code>EMPTY</code> to report a "generic" error.
+Field "success" reports result of processing request, while criu_***_resp store some request-specific information. The response type is set to the corresponding request type or to <code>EMPTY</code> to report a "generic" error. If success == false one should check cr_errno field to get a more detailed error code(see [https://github.com/xemul/criu/blob/master/include/cr-errno.h#L8 include/cr-errno.h]).
 ;The criu_dump_resp is used to store response from DUMP request.