Skip to content

Commit 04ddeaa

Browse files
text additions.
1 parent 69facae commit 04ddeaa

File tree

2 files changed

+25
-8
lines changed

2 files changed

+25
-8
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,6 @@ foreach ($protocol->getResponses() as $response) {
182182
Directory `src` contains autoload file which accepts only Bolt library namespaces. Main Bolt namespace points to this
183183
directory. If you have installed this project with composer, you have to load `vendor/autoload.php`.
184184

185-
## :vertical_traffic_light: Server state
186-
187-
Server state is not reported by server but it is evaluated by received response. You can access current state through property `$protocol->serverState`. This property is updated with every call `getResponse(s)`.
188-
189185
## :chains: Connection
190186

191187
Bolt class constructor accepts connection argument. This argument has to be instance of class which implements IConnection interface. Library offers few options.
@@ -253,6 +249,10 @@ timeout for establishing socket connection itself you have to set ini directive
253249
_Setting up ini directive isn't part of connection class because function `ini_set` can be disabled on production
254250
environments for security reasons._
255251

252+
## :vertical_traffic_light: Server state
253+
254+
Server state is not reported by server but it is evaluated by received response. You can access current state through property `$protocol->serverState`. This property is updated with every call `getResponse(s)`.
255+
256256
## :pushpin: More solutions
257257

258258
If you need simple class to cover basic functionality you can

src/enum/Signature.php

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,25 @@
1111
enum Signature: int
1212
{
1313
case NONE = 0;
14-
case SUCCESS = 0x70; //112
15-
case FAILURE = 0x7F; //127
16-
case IGNORED = 0x7E; //126
17-
case RECORD = 0x71; //113
14+
/**
15+
* The SUCCESS message indicates that the corresponding request has succeeded as intended. It may contain metadata relating to the outcome. Metadata keys are described in the section of this document relating to the message that began the exchange.
16+
* @internal 112
17+
*/
18+
case SUCCESS = 0x70;
19+
/**
20+
* A FAILURE message response indicates that the client is not permitted to exchange further messages. Servers may choose to include metadata describing the nature of the failure.
21+
* @internal 127
22+
*/
23+
case FAILURE = 0x7F;
24+
/**
25+
* The IGNORED message indicates that the corresponding request has not been carried out.
26+
* @internal 126
27+
*/
28+
case IGNORED = 0x7E;
29+
/**
30+
* A RECORD message carries a sequence of values corresponding to a single entry in a result.
31+
* These messages are currently only ever received in response to a PULL (PULL_ALL in v1, v2, and v3) message and will always be followed by a summary message.
32+
* @internal 113
33+
*/
34+
case RECORD = 0x71;
1835
}

0 commit comments

Comments
 (0)