|
1 |
| -# clue/redis-protocol [](https://travis-ci.org/clue/php-redis-protocol) |
| 1 | +# clue/redis-protocol |
2 | 2 |
|
3 |
| -[](https://github.com/clue/php-redis-protocol/actions) |
| 3 | +[](https://github.com/clue/redis-protocol/actions) |
4 | 4 | [](https://packagist.org/packages/clue/redis-protocol)
|
5 | 5 |
|
6 |
| -A streaming redis protocol parser and serializer written in PHP |
| 6 | +A streaming Redis protocol (RESP) parser and serializer written in pure PHP. |
7 | 7 |
|
8 |
| -This parser and serializer implementation allows you to parse redis protocol |
| 8 | +This parser and serializer implementation allows you to parse Redis protocol |
9 | 9 | messages into native PHP values and vice-versa. This is usually needed by a
|
10 |
| -redis client implementation which also handles the connection socket. |
| 10 | +Redis client implementation which also handles the connection socket. |
11 | 11 |
|
12 |
| -To re-iterate: This is *not* a redis client implementation. This is a protocol |
13 |
| -implementation that is usually used by a redis client implementation. If you're |
| 12 | +To re-iterate: This is *not* a Redis client implementation. This is a protocol |
| 13 | +implementation that is usually used by a Redis client implementation. If you're |
14 | 14 | looking for an easy way to build your own client implementation, then this is
|
15 |
| -for you. If you merely want to connect to a redis server and issue some |
| 15 | +for you. If you merely want to connect to a Redis server and issue some |
16 | 16 | commands, you're probably better off using one of the existing client
|
17 | 17 | implementations.
|
18 | 18 |
|
@@ -62,15 +62,15 @@ your use-case).
|
62 | 62 |
|
63 | 63 | ### Parser
|
64 | 64 |
|
65 |
| -The library includes a streaming redis protocol parser. As such, it can safely |
66 |
| -parse redis protocol messages and work with an incomplete data stream. For this, |
| 65 | +The library includes a streaming Redis protocol parser. As such, it can safely |
| 66 | +parse Redis protocol messages and work with an incomplete data stream. For this, |
67 | 67 | each included parser implements a single method
|
68 | 68 | `ParserInterface::pushIncoming($chunk)`.
|
69 | 69 |
|
70 |
| -* The `ResponseParser` is what most redis client implementation would want to |
71 |
| - use in order to parse incoming response messages from a redis server instance. |
72 |
| -* The `RequestParser` can be used to test messages coming from a redis client or |
73 |
| - even to implement a redis server. |
| 70 | +* The `ResponseParser` is what most Redis client implementation would want to |
| 71 | + use in order to parse incoming response messages from a Redis server instance. |
| 72 | +* The `RequestParser` can be used to test messages coming from a Redis client or |
| 73 | + even to implement a Redis server. |
74 | 74 | * The `MessageBuffer` decorates either of the available parsers and merely
|
75 | 75 | offers some helper methods in order to work with single messages:
|
76 | 76 | * `hasIncomingModel()` to check if there's a complete message in the pipeline
|
@@ -121,7 +121,7 @@ assert($model implement Model\MultiBulkReply);
|
121 | 121 | ## Install
|
122 | 122 |
|
123 | 123 | It's very unlikely you'll want to use this protocol parser standalone.
|
124 |
| -It should be added as a dependency to your redis client implementation instead. |
| 124 | +It should be added as a dependency to your Redis client implementation instead. |
125 | 125 | The recommended way to install this library is [through Composer](https://getcomposer.org).
|
126 | 126 | [New to Composer?](https://getcomposer.org/doc/00-intro.md)
|
127 | 127 |
|
|
0 commit comments