8/RSCTRL - Remote Service Control Protocol

domain:

github.com/FirebirdSQL/Butler

shortname:

8/RSCTRL

name:

Remote Service Control Protocol

status:

raw

editor:

Pavel Císař <pcisar@users.sourceforge.net>

Remote Service Control Protocol (RSCTRL) specifies a uniform method for controlling Firebird Butler Service operations 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 control messages between Butler Service and its Client. Its goals are:

  1. Define unified, flexible and extensible data format for control information, suitable for remote Service control purposes.

  2. Define serialization format for such control information suitable for transmission in 4/FBSP Data Frames.

  3. Define a base API for transmitting such control information between the Firebird Butler Service and the Client.

  4. Define a base API for remote Service control by its Client.

2. Implementation

Todo

Specification body.