mirror of
https://github.com/avatao-content/baseimage-tutorial-framework
synced 2024-11-22 18:21:31 +00:00
Created process.stop (markdown)
parent
f8d1972d0a
commit
0054e2a4d6
54
process.stop.md
Normal file
54
process.stop.md
Normal file
@ -0,0 +1,54 @@
|
||||
### Request
|
||||
* **Description**: Instructs the supervisor daemon to stop a registered process.
|
||||
* **Subscribers**: [ProcessHandler](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/ProcessHandler)
|
||||
|
||||
```json
|
||||
{
|
||||
"key": "process.stop",
|
||||
"intent": "control",
|
||||
"scope": "zmq"
|
||||
}
|
||||
```
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------ |:--------:|:------------------:| --------------------------- |
|
||||
| *name* | `string` | :heavy_check_mark: | Name of the process. |
|
||||
|
||||
***
|
||||
|
||||
**Example**:
|
||||
```json
|
||||
{
|
||||
"key": "process.stop",
|
||||
"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.stop",
|
||||
"intent": "event",
|
||||
"scope": "broadcast"
|
||||
}
|
||||
```
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------ |:--------:|:------------------:| --------------------------- |
|
||||
| *name* | `string` | :heavy_check_mark: | Name of of the process. |
|
||||
| *error* | `string` | | Error message from the supervisor daemon. |
|
||||
|
||||
***
|
||||
|
||||
**Example**:
|
||||
```json
|
||||
{
|
||||
"key": "process.stop",
|
||||
"intent": "event",
|
||||
"scope": "broadcast",
|
||||
"name": "webservice",
|
||||
}
|
||||
```
|
Loading…
Reference in New Issue
Block a user