Skip to content

Commit

Permalink
Clarification on duplicate connectionKey and future deprecation
Browse files Browse the repository at this point in the history
  • Loading branch information
mattheworiordan committed Nov 2, 2015
1 parent 46b0391 commit 0b81f11
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions content/client-lib-development-guide/features.textile
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ h4. ProtocolMessage
** @(TR4b)@ @channel@ string
** @(TR4c)@ @channelSerial@ string
** @(TR4d)@ @connectionId@ string
** @(TR4e)@ @connectionKey@ string
** @(TR4e)@ @connectionKey@ string. Note that this field is soon to be deprecated; when @ConnectionDetails#connectionKey@ is present, it should be considered the definitive @connectionKey@ for the current connection
** @(TR4f)@ @connectionSerial@ long
** @(TR4o)@ @connectionDetails@ @ConnectionDetails@ object - provides details on the constraints or defaults for the connection such as max message size, client ID or connection state TTL
** @(TR4g)@ @count@ integer
Expand Down Expand Up @@ -595,7 +595,7 @@ h4. ConnectionDetails
* @(CD1)@ Connection details are optionally passed to the client library in the @CONNECTED@ @ProtocolMessage#connectionDetails@ attribute to inform the client about any constraints it should adhere to, and provide additional metadata about the connection. For example, if a request is made to publish a message that exceeds the @maxMessageSize@, the client library can reject the message immediately, without communicating with the Ably service
* @(CD2)@ Attributes available in @ConnectionDetails@:
** @(CD2a)@ @clientId@ contains the client ID assigned to the token. If @clientId@ is @null@ or omitted, then the client is prohibited from assuming a @clientId@ in any operations, however if @clientId@ is a wildcard string @'*'@, then the client is permitted to assume any @clientId@. Any other string value for @clientId@ implies that the @clientId@ is both enforced and assumed for all operations from this client
** @(CD2b)@ @connectionKey@ is the connection secret key string that is used to resume a connection and its state
** @(CD2b)@ @connectionKey@ is the connection secret key string that is used to resume a connection and its state. When present, this @connectionKey@ should be considered the definitive @connectionKey@ for the current connection and the soon to be deprecated @ProtocolMessage#connectionKey@ should be ignored
** @(CD2c)@ @maxMessageSize@ is the maximum individual message size in bytes
** @(CD2d)@ @maxFrameSize@ is the maximum size for a single frame of data sent to Ably. This restriction applies to a @ProtocolMessage@ sent over a realtime connection, or the total body size for a REST request
** @(CD2e)@ @maxInboundRate@ is the maximum allowable number of requests per second from a client or Ably. In the case of a realtime connection, this restriction applies to the number of @ProtocolMessage@ objects sent, whereas in the case of REST, it is the total number of REST requests per second
Expand Down

0 comments on commit 0b81f11

Please sign in to comment.