=head1 SYNOPSIS
- >>> PING "hello"
- <<< 1.0 200 hello
+ <<< PING "hello"
+ >>> 1.0 200 hello
=head1 DESCRIPTION
A typical request/reply cycle looks like:
- >>> PING "hello"
- <<< 1.0 200 hello
+ <<< PING "hello"
+ >>> 1.0 200 hello
In this case the request was the literal string C<"PING \"hello\"\r\n">
(note: followed by carriage return [CR] and line feed [LF]).
The reply was C<"1.0 200 hello\r\n">.
-The E<gt>E<gt>E<gt> and E<lt>E<lt>E<lt> symbols are not part of
+The E<lt>E<lt>E<lt> and E<gt>E<gt>E<gt> symbols are not part of
the protocol. They indicate messages sent to the host and
received from the host respectively.
A few commands return a multi-line response:
- >>> CAPABILITIES
- <<< 1.0 200
- <<< Content-Type: text/xml
- <<< Content-Length: 123
- <<<
- <<< <capabilities>
- <<< <host>
- <<< <cpu>
- <<< <arch>i686</arch>
+ <<< CAPABILITIES
+ >>> 1.0 200
+ >>> Content-Type: text/xml
+ >>> Content-Length: 123
+ >>>
+ >>> <capabilities>
+ >>> <host>
+ >>> <cpu>
+ >>> <arch>i686</arch>
(etc.)
The multi-line response consists of headers and blank line and a body,
When a command returns an error, the request / response looks like
this:
- >>> NOSUCHCOMMAND
- <<< 1.0 404 Command not found
+ <<< NOSUCHCOMMAND
+ >>> 1.0 404 Command not found
As in HTTP, C<4xx> and C<5xx> status codes indicate classes of
error. Following the error code is an explanatory string.
=head3 Example
- >>> AVAILCPUS
- <<< 1.0 200 4
+ <<< AVAILCPUS
+ >>> 1.0 200 4
=head3 Description
=head3 Example
- >>> CORESPERSOCKET
- <<< 1.0 200 2
+ <<< CORESPERSOCKET
+ >>> 1.0 200 2
=head3 Description
=head3 Example
- >>> MEMORY
- <<< 1.0 200 2097022
+ <<< MEMORY
+ >>> 1.0 200 2097022
=head3 Description
=head3 Example
- >>> MHZ
- <<< 1.0 200 2047
+ <<< MHZ
+ >>> 1.0 200 2047
=head3 Description
=head3 Example
- >>> MODEL
- <<< 1.0 200 x86_64
+ <<< MODEL
+ >>> 1.0 200 x86_64
=head3 Description
=head3 Example
- >>> NODES
- <<< 1.0 200 1
+ <<< NODES
+ >>> 1.0 200 1
=head3 Description
=head3 Example
- >>> PHYSCPUS
- <<< 1.0 200 4
+ <<< PHYSCPUS
+ >>> 1.0 200 4
=head3 Description
=head3 Example
- >>> PING "hello"
- <<< 1.0 200 hello
+ <<< PING "hello"
+ >>> 1.0 200 hello
=head3 Description
=head3 Example
- >>> SOCKETSPERNODE
- <<< 1.0 200 2
+ <<< SOCKETSPERNODE
+ >>> 1.0 200 2
=head3 Description
=head3 Example
- >>> THREADSPERCORE
- <<< 1.0 200 1
+ <<< THREADSPERCORE
+ >>> 1.0 200 1
=head3 Description