Skip to content

Commit ef41510

Browse files
Add receptorctl work results doc (#1064)
1 parent 9753cfb commit ef41510

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

docs/source/receptorctl/receptorctl_index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ The Receptor client, ``receptorctl``, provides a command line interface for inte
1818
receptorctl_work_cancel
1919
receptorctl_work_list
2020
receptorctl_work_release
21+
receptorctl_work_results
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
------------
2+
work results
3+
------------
4+
5+
.. contents::
6+
:local:
7+
8+
``receptorctl work results`` gets results for successfully completed, failed, stopped, or currently running, units of work.
9+
10+
Command syntax: ``receptorctl --socket=<socket_path> work results [<<Options>>] <<Unit ID>> [...]``
11+
12+
``socket_path`` is the control socket address for the Receptor connection.
13+
The default is ``unix:`` for a Unix socket.
14+
Use ``tcp://`` for a TCP socket.
15+
The corresponding environment variable is ``RECEPTORCTL_SOCKET``.
16+
17+
.. code-block:: text
18+
19+
ss --listening --processes --unix 'src = unix:<socket_path>'
20+
Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process
21+
u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7))
22+
23+
``ps -fp $(pidof receptor)``
24+
``lsof -p <pid>``
25+
26+
``Unit ID`` is a unique identifier for a work unit (job). When running the ``work results`` command, you should specify the ``Unit ID`` for the Receptor node to which you are connected.

0 commit comments

Comments
 (0)