github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove redundancy. Events will now be described in each section, as required.

Browse Source
This commit is contained in:
dlavigne
2016-03-29 10:06:52 -04:00
parent 842a594ce3
commit 6705c0b70c
3 changed files with 6 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
api/connection.rst
View File

@@ -231,9 +231,11 @@ Dispatcher Subsystem
The dispatcher subsystem is designed for running external utilities or scripts in an asynchronous fashion. Any connected client can subscribe to per-connection event notifications about
dispatcher processes through the events system, but only users in the *wheel* group have the authority to directly submit new jobs for the dispatcher.
.. note:: other subsystems may also use the dispatcher for long-running processes in the background, and these subsystems may allow non-wheel group users to perform these tasks as necessary.
.. note:: other subsystems may also use the dispatcher for long-running processes in the background, and these subsystems may allow non-wheel group users to perform these tasks as
necessary. Also, the events namespace does not really translate over to REST which was not designed for asyncronous events. For this reason, only Websocket examples are used in this
section.
The user needs to first subscribe to "dispatcher" event notifications:
The format of "dispatcher" event requests is as follows:
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| **Parameter** | **Value** | **Description** |
@@ -263,7 +265,8 @@ For example, to subscribe to dispatcher events:
"args" : ["dispatcher"]
}
To unsubscribe from dispatcher events:
Once subscribed, the requested events will be received as they are produced. To unsubscribe from event notifications, repeat the request, using "unsubscribe" for the "name". For example,
to unsubscribe from dispatcher events:
.. code-block:: json

61
api/events.rst
View File

@@ -1,61 +0,0 @@
.. _Events:
Events
******
The "events" namespace can be used to setup and receive asyncronous updates about system status and other types of system notifications.
.. _note: the events namespace does not really translate over to REST which was not designed for asyncronous events. For this reason, only Websocket examples are used in this section.
Every events request contains the following parameters:
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| **Parameter** | **Value** | **Description** |
| | | |
+=================================+===============+======================================================================================================================+
| id | | any unique value for the request; examples include a hash, checksum, or uuid |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| name | | supported values are "subscribe" or unsubscribe" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| namespace | events | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| args | | values vary by type of class |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
Here is an example of subscribing to Life Preserver events:
**Websocket Request**
.. code-block:: json
{
"namespace" : "events",
"name" : "subscribe",
"id" : "sampleID",
"args" : ["dispatcher", "life-preserver"]
}
Once subscribed, events will be received as they are produced. To unsubscribe from events, repeat the request, using "unsubscribe" for the "name".
Here is an example reply:
**Websocket Reply**
.. code-block:: json
{
"namespace" : "events",
"name" : "life-preserver",
"id" : "<none>"
"args" : {
"message" : <message>,
"priority" : "<number> -
<category>",
"class" : "[snapshot/replication]"
}
}

1
api/index.rst
View File

@@ -7,7 +7,6 @@ PC-BSD® API Reference
connection
users
events
classes/index
Indices and tables