Skip to content

Commit 1ffd727

Browse files
authored
Merge pull request #482 from chu11/rfc43_job_list_stream
rfc43: update job-list.list to streaming RPC
2 parents e74aa14 + 3ab2b84 commit 1ffd727

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

spec_43.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ List
272272

273273
The :program:`job-list.list` RPC fetches a list of jobs.
274274

275-
The list of jobs shall be filtered in the following order.
275+
The list of jobs SHALL be filtered in the following order.
276276

277277
- pending jobs
278278
- running jobs
@@ -282,6 +282,12 @@ Pending jobs are returned ordered by priority (higher priority first),
282282
running jobs ordered by start time (most recent first), and inactive
283283
jobs ordered by completion (most recently finished first)
284284

285+
The RPC request SHOULD specify FLUX_MSGFLAG_STREAMING as described in
286+
RFC 6 so that the server has the opportunity to manage response
287+
message size for large query results. When that flag is specified,
288+
responses SHALL be split over multiple messages, terminated with error
289+
61, "No data available" (ENODATA).
290+
285291
The RPC payloads are defined as follows:
286292

287293
.. object:: job-info.lookup request
@@ -313,7 +319,8 @@ The RPC payloads are defined as follows:
313319

314320
.. object:: job-info.lookup response
315321

316-
The response SHALL consist of a JSON object with the following keys:
322+
Each non-error response SHALL consist of a JSON object with the
323+
following keys:
317324

318325
.. object:: jobs
319326

0 commit comments

Comments
 (0)