Commit 4e80c955 authored by Kyle Sunden's avatar Kyle Sunden

Merge branch '300' into 'master'

YEP-300: is-daemon

See merge request !37
parents 9938237d 64a7da61
Pipeline #166581253 passed with stage
---
yep: 300
title: is-daemon
author: Blaise Thompson
status: draft
author: Blaise Thompson <blaise@untzag.com>
status: accepted
tags: trait
post-history: 2020-04-22
2020-07-14
---
This YEP is a stub.
# Abstract
This YEP defines the is-daemon trait.
This is a core trait which applies to all yaq daemon.
In other words, this YEP defines the config, state, and messages that all yaq daemons must implement.
This trait has been accepted.
See built documentation at at [yaq.fyi](https://yaq.fyi/traits/is-daemon/).
# Table of Contents
[TOC]
# Motivation
The config, state, and messages here must be implemented by all yaq daemons.
# Proposal
## config: port
type: int
TCP port for daemon to occupy.
## config: serial
type: [null, string]
default: null
Serial number for the particular device represented by the daemon.
## config: make
type: [null, string]
default: null
Make (manufacturer) for the particular device represented by the daemon.
## config: model
type: [null, string]
default: null
Model (manufacturer part number) for the particular device represented by the daemon.
## message: busy
response: boolean
Returns true if daemon is currently busy.
## message: id
response: {'type': 'map', 'values': ['null', 'string']}
Map with information to identify the daemon, including name, kind, make, model, serial.
## message: get_config_filepath
response: string
String representing the absolute filepath of the configuration file on the host machine.
## message: get_config
response: string
Full configuration for the individual daemon as defined in the TOML file. This includes defaults and shared settings not directly specified in the daemon-specific TOML table.
## message: shutdown
parameter: restart: boolean <br>
parameter: restart: default: false
Cleanly shutdown (or restart) daemon.
## message: get_state
response: string
Daemon state toml file dumped as a as string.
# Discussion
Discussion can be found on the [gitlab issue](https://gitlab.com/yaq/yeps/-/issues/14) for this YEP.
# Copyright
This document is placed in the public domain or under the CC0-1.0-Universal license, whichever is more permissive.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment