mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2024-11-23 07:01:32 +00:00
Code Issues Releases Wiki Activity

Created process.restart (markdown)

ni-richard 2019-09-12 16:02:49 +02:00
parent 6290055d26
commit 99c989a8fa
1 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
process.restart.md Normal file

@ -0,0 +1,55 @@
### Request
* **Description**: Instructs the supervisor daemon to restart a registered process.
* **Subscribers**: [ProcessHandler](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/ProcessHandler)
```json
{
"key": "process.restart",
"intent": "control",
"scope": "zmq"
}
```
| Parameter | Type | Required | Description |
| ------------ |:--------:|:------------------:| --------------------------- |
| *name* | `string` | :heavy_check_mark: | Name of the process. |
***
**Example**:
```json
{
"key": "process.restart",
"name": "webservice"
}
```
### Response
* **Description**: Raises an event that contains an `error` field if the process exited with an error code, otherwise it's just the same as the original request.
* **Subscribers**: *(none)*
```json
{
"key": "process.restart",
"intent": "event",
"scope": "broadcast"
}
```
| Parameter | Type | Required | Description |
| ------------ |:--------:|:------------------:| --------------------------- |
| *name* | `string` | :heavy_check_mark: | Name of the process. |
| *error* | `string` | | Error message from the supervisor daemon. |
***
**Example**:
```json
{
"key": "process.restart",
"intent": "event",
"scope": "broadcast",
"name": "webservice",
"error": "SPAWN_ERROR: webservice..."
}
```