Skip to content

Commit 3623c40

Browse files
mattheworiordanclaude
authored andcommitted
fix: remove cross-references from RTN2b and TO3h to RTL4n
These cross-references leak channel-level concerns into the connection domain. The echo channel param is documented in RTL4n where it belongs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 8749967 commit 3623c40

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

specifications/features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ The threading and/or asynchronous model for each realtime library will vary by l
504504
- `(RTN1)` `Connection` connects to the Ably service using a [websocket](https://ably.com/topic/websockets) connection. The [ably-js library](https://github.com/ably/ably-js) supports additional transports such as Comet and XHR streaming; however non-browser client libraries typically use only a websocket transport
505505
- `(RTN2)` The default host used for realtime [websocket](https://ably.com/topic/websockets) connections is the [`REC1`](#REC1) primary domain and the following query string params should be used when opening a new connection:
506506
- `(RTN2a)` `format` should be `msgpack` (default) or `json`
507-
- `(RTN2b)` `echo` should be `true` if the `echoMessages` client option is true; else it should be `false`, which will prevent messages published by the client being echoed back. The connection-level `echo` setting may be overridden on a per-channel basis using the `echo` channel param; see [`RTL4n`](#RTL4n)
507+
- `(RTN2b)` `echo` should be `true` if the `echoMessages` client option is true; else it should be `false`, which will prevent messages published by the client being echoed back
508508
- `(RTN2d)` `clientId` contains the provided `clientId` option of `ClientOptions`, unless `clientId` is `null`
509509
- `(RTN2e)` Depending on the authentication scheme, either `accessToken` contains the token string, or `key` contains the API key
510510
- `(RTN2f)` The API version param `v` must be included in all connections to Ably endpoints. The value to be sent is defined by [`CSV2`](#CSV2).
@@ -1880,7 +1880,7 @@ The core SDK provides an API for wrapper SDKs to supply Ably with analytics info
18801880
- `(TO3e)` `autoConnect` boolean - defaults to true. If false, suppresses the automatic initiation of a connection when the library is instantiated
18811881
- `(TO3f)` `useBinaryProtocol` boolean - defaults to true. If false, forces the library to use the JSON encoding for REST and Realtime operations, instead of the default binary msgpack encoding
18821882
- `(TO3g)` `queueMessages` boolean - defaults to true. If false, suppresses the default queueing of `MESSAGE`, `PRESENCE`, `ANNOTATION` or `OBJECT` protocol messages. See [RTL6c](#RTL6c) for connection and channel state condition details
1883-
- `(TO3h)` `echoMessages` boolean - defaults to true. If false, suppresses messages originating from this connection being echoed back on the same connection. Per-channel echo suppression can also be configured using the `echo` channel param; see [`RTL4n`](#RTL4n)
1883+
- `(TO3h)` `echoMessages` boolean - defaults to true. If false, suppresses messages originating from this connection being echoed back on the same connection
18841884
- `(TO3i)` `recover` string - A connection recovery string, specified with the intention of inheriting the state of an earlier connection
18851885
- `(TO3n)` `idempotentRestPublishing` boolean - defaults to false for clients with version \< 1.2, otherwise true. If true, [RSL1k](#RSL1k1) applies
18861886
- `(TO3j)` Auth option attributes:

0 commit comments

Comments
 (0)