This repository has been archived by the owner on Apr 14, 2023. It is now read-only.
docs(KEEP_ALIVE): updated protocol documentation to explain the correct workflow between connection_init, connection_ack and connection_keep_alive messages #279
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ct workflow between connection init, connection ack and connection keep alive.
NeoPhi
approved these changes
Oct 6, 2017
| @@ -21,7 +21,7 @@ export interface OperationMessage { | |||
| #### GQL_CONNECTION_INIT | |||
| Client sends this message after plain websocket connection to start the communication with the server | |||
|
|
|||
| The server will response only with `GQL_CONNECTION_ACK` or `GQL_CONNECTION_ERROR` to this message. | |||
| The server will response only with `GQL_CONNECTION_ACK` + `GQL_CONNECTION_KEEP_ALIVE` (if used) or `GQL_CONNECTION_ERROR` to this message. | |||
There was a problem hiding this comment.
While very unlikely it would be possible when keep alive is in use for the server to send GQL_CONNECTION_ACK and then GQL_CONNECTION_ERROR if for some reason the GQL_CONNECTION_KEEP_ALIVE failed to send.
There was a problem hiding this comment.
if KEEP_ALIVE failed to send, ERROR will be failing as well...
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes a missing information on the protocol documentation that should explains the correct message flow between the messages: connection_init, connection_ack and connection_keep_alive messages.
The one suggested by the current documentation is:
--> connection_init- 0s<-- connection_ack- 0s<-- ka. - 10sWhich is wrong.
The one suggested by this docs update, and the one that should be used is:
--> connection_init- 0s<-- connection_ack- 0s<-- ka. - 0s<-- ka. - 10sYou can found more information about how I found this, in a discussion between myself and some graphcool guys here prisma/prisma1#309.