7/RSCFG - Remote Service Configuration Protocol¶
| domain: | github.com/FirebirdSQL/Butler |
|---|---|
| shortname: | 7/RSCFG |
| name: | Remote Service Configuration Protocol |
| status: | raw |
| editor: | Pavel Císař <pcisar@users.sourceforge.net> |
Remote Service Configuration Protocol (RSCFG) specifies a uniform method for configuring Firebird Butler Service operating parameters through Client requests passed via 4/FBSP protocol.
License¶
Copyright (c) 2018 The Firebird Butler Project.
This Specification is distributed under Creative Commons Attribution-ShareAlike 4.0 International license.
You should have received a copy of the CC BY-SA 4.0 along with this document; if not, see https://creativecommons.org/licenses/by-sa/4.0/
Change Process¶
This Specification is a free and open standard and is governed by the Consensus-Oriented Specification System (COSS) (see “2/COSS - Consensus-Oriented Specification System”).
Important
This specification is still incomplete (work in progress), hence the COSS change process is not yet fully applicable. All ideas and change proposals SHOULD be presented and discussed in Firebird Butler forum.
Language¶
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC2119.
1. Goals¶
The purpose of this specification is to define unified data format, and formal rules for exchanging configuration information between Butler Service and its Client. Its goals are:
- Define unified, flexible and extensible data format for Service configuration information, suitable for diagnostic and control purposes.
- Define serialization format for such configuration information suitable for transmission in 4/FBSP Data Frames.
- Define a base API for transmitting such configuration information between the Firebird Butler Service and the Client.
- Define a base API for remote Service configuration by its Client.