Skip to content

Commit b1fce53

Browse files
committed
Changed status for 5 core specifications
1 parent 1009d14 commit b1fce53

6 files changed

Lines changed: 22 additions & 15 deletions

File tree

rfc/1/C4.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:domain: github.com/FirebirdSQL/Butler
66
:shortname: 1/C4
77
:name: Collective Code Construction Contract
8-
:status: draft
8+
:status: stable
99
:editor: Pavel Císař <pcisar@users.sourceforge.net>
1010

1111

rfc/2/COSS.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:domain: github.com/FirebirdSQL/Butler
66
:shortname: 2/COSS
77
:name: Consensus-Oriented Specification System
8-
:status: draft
8+
:status: stable
99
:editor: Pavel Císař <pcisar@users.sourceforge.net>
1010

1111

rfc/3/FBSD.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:domain: github.com/FirebirdSQL/Butler
66
:shortname: 3/FBSD
77
:name: Firebird Butler Service Definition
8-
:status: raw
8+
:status: draft
99
:editor: Pavel Císař <pcisar@users.sourceforge.net>
1010

1111
This document describes a specific category of software components capable of providing their services to clients working in the same or different contexts where the context may be a thread or a process. It defines common functionality and operational parameters to ensure interoperability and integration under defined working conditions.

rfc/4/FBSP.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:domain: github.com/FirebirdSQL/Butler
66
:shortname: 4/FBSP
77
:name: Firebird Butler Service Protocol
8-
:status: raw
8+
:status: draft
99
:editor: Pavel Císař <pcisar@users.sourceforge.net>
1010

1111
The Firebird Butler Service Protocol (FBSP) defines formal rules for exchanging messages between Butler Service and its Client over Service Sockets as they are defined in |FBSD|.
@@ -283,7 +283,7 @@ The REQUEST message is a `Client` request to the `Service`.
283283
3. The `Service` MUST respond to this message by sending REPLY_ or ERROR_ message with the same `Request Code`_ in type-data_ field.
284284
4. The `Service` MAY send additional subsequent messages in response to the same REQUEST message.
285285
5. The type and number of messages in reply to particular request, as well as method for indicating the end of the message stream to the `Client` SHALL be defined by the API for particular `Request Code`_.
286-
6. When ACK-REQUEST_ flag is set in received REQUEST message, the `Service` MUST respond according to rules for ACK-REQUEST_ flag handling. This ACK response MUST be immediate, before further processing of the request.
286+
6. When ACK-REQUEST_ flag is set in received REQUEST message, the `Service` MUST respond according to rules for ACK-REQUEST_ flag handling.
287287

288288
.. seealso::
289289

@@ -328,8 +328,9 @@ The CANCEL message represents a request for a `Service` to stop processing the p
328328
1. One CANCEL message is a request to end the processing of one active request.
329329
2. The content of type-data_ field in this message is not significant.
330330
3. The message MUST have a data-frame_ with specification of the request whose processing is to be terminated. The data-frame_ MAY contain additional information.
331-
4. The `Service` SHALL terminate specified active request of the `Client`, and send the REPLY_ message to the `Client` when cancellation is successfully finished. The REPLY_ message MAY have a data-frame_ with additional information.
332-
5. If the `Service` can not stop processing the request whose cancellation is requested, it MUST respond with the ERROR_ message.
331+
4. The `Service` MUST respond with the ERROR_ message with appropriate `Error Code`_.
332+
5. If `Service` successfully terminated specified active `Client` request, the ERROR_ message MUST have `Request Canceled` `Error Code`_.
333+
6. The ERROR_ message MAY have a data-frame_ with additional information.
333334

334335
.. seealso::
335336

@@ -514,7 +515,7 @@ The `Service API` consists from `Interfaces` (API contracts) that consists from
514515
The `Request Code` uniquely identifies the `Service` functionality (an API call). This specification define following rules for request codes:
515516

516517
1. The first (more significant) byte of type-data_ field SHALL contain the `Interface identification number` assigned by `Service` to particular `Interface` it supports (see :ref:`Data frames - WELCOME <welcome-dataframe>`).
517-
2. The second (less significant byte) byte of type-data_ field SHALL contain the `Interface operation code`.
518+
2. The second (less significant) byte of type-data_ field SHALL contain the `Interface operation code`.
518519

519520

520521
.. _protocol-buffer:
@@ -747,6 +748,10 @@ Errors indicating that particular request cannot be satisfied
747748
:16 - Insufficient Storage:
748749

749750
The service is unable to store data needed to successfully complete the request.
751+
752+
:17 - Request Canceled:
753+
754+
The client's request was canceled by CANCEL_ request.
750755

751756

752757
Fatal errors indicating that connection would/should be terminated

rfc/9/FBDP.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:domain: github.com/FirebirdSQL/Butler
66
:shortname: 9/FBDP
77
:name: Firebird Butler Data Pipe Protocol
8-
:status: raw
8+
:status: draft
99
:editor: Pavel Císař <pcisar@users.sourceforge.net>
1010

1111
The Firebird Butler Data Pipe Protocol (FBDP) defines unified data format, and formal rules for exchanging user data messages through a Data Pipe in accordance with the specification in |Data Pipe Definition|.

specifications.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,27 +26,29 @@ Raw
2626
.. toctree::
2727
:maxdepth: 1
2828

29-
/rfc/3/FBSD
30-
/rfc/4/FBSP
3129
/rfc/5/FBLP
3230
/rfc/6/SSTP
3331
/rfc/7/RSCFG
3432
/rfc/8/RSCTRL
35-
/rfc/9/FBDP
3633

3734
Draft
3835
=====
3936

4037
.. toctree::
4138
:maxdepth: 1
4239

43-
/rfc/1/C4
44-
/rfc/2/COSS
40+
/rfc/3/FBSD
41+
/rfc/4/FBSP
42+
/rfc/9/FBDP
4543

4644
Stable
4745
======
4846

49-
None at this time.
47+
.. toctree::
48+
:maxdepth: 1
49+
50+
/rfc/1/C4
51+
/rfc/2/COSS
5052

5153
Deprecated
5254
==========

0 commit comments

Comments
 (0)