Skip to content

Commit b66c60a

Browse files
committed
Change ConnectionDetails.gcGracePeriod to ConnectionDetails.objectsGCGracePeriod
The previous `gcGracePeriod` name was never used in production so we can update the spec without deleting the old spec points
1 parent 0516646 commit b66c60a

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

textile/features.textile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1828,7 +1828,7 @@ h4. ConnectionDetails
18281828
** @(CD2f)@ @connectionStateTtl@ is the duration that Ably will persist the connection state when a Realtime client is abruptly disconnected
18291829
** @(CD2g)@ @serverId@ string is a unique identifier for the front-end server that the client has connected to. This server ID is only used for the purposes of debugging
18301830
** @(CD2h)@ @maxIdleInterval@ is the maximum length of time in milliseconds that the server will allow no activity to occur in the server->client direction. After such a period of inactivity, the server will send a @HEARTBEAT@ or transport-level ping to the client. If the value is 0, the server will allow arbitrarily-long levels of inactivity.
1831-
** @(CD2i)@ @gcGracePeriod@ number is the length of time, in milliseconds, that the client library must wait before releasing resources for tombstoned objects and map entries (see "RTO10":../objects-features#RTO10)
1831+
** @(CD2i)@ @objectsGCGracePeriod@ integer - the length of time, in milliseconds, that the client library must wait before releasing resources for tombstoned objects and map entries (see "RTO10":../objects-features#RTO10)
18321832
h4. ChannelProperties
18331833
* @(CP1)@ properties of a channel and its state
18341834
* @(CP2)@ The attributes of @ChannelProperties@ consist of:
@@ -2541,7 +2541,7 @@ class ConnectionDetails: // CD*, internal
25412541
maxMessageSize: Int // CD2c
25422542
serverId: String // CD2g
25432543
maxIdleInterval: Duration // CD2h
2544-
gcGracePeriod: Int // CD2i
2544+
objectsGCGracePeriod: Int // CD2i
25452545

25462546
class Message: // TM*
25472547
constructor(name: String?, data: Data?) // TM4

textile/objects-features.textile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ h3(#realtime-objects). RealtimeObjects
9090
* @(RTO10)@ The client library must have a process in place to regularly check for objects and map entries that have been tombstoned for a period of time, and release their resources so they can be garbage collected. Tombstoned objects and map entries are retained in memory for a sufficient grace period (at least >2 minutes) to ensure that no late-arriving operation is mistakenly applied to an object or map entry the client has already "forgotten" about.
9191
** @(RTO10a)@ The check should occur at regular intervals, for example, every 5 minutes
9292
** @(RTO10b)@ The grace period for releasing resources for tombstoned objects and map entries is determined as follows:
93-
*** @(RTO10b1)@ It is equal to "@ConnectionDetails.gcGracePeriod@":../features#CD2i received in the @CONNECTED@ @ProtocolMessage@
94-
*** @(RTO10b2)@ The grace period value is updated to match the new @ConnectionDetails.gcGracePeriod@ value whenever a new @CONNECTED@ @ProtocolMessage@ is received per "RTN24":../features#RTN24
95-
*** @(RTO10b3)@ A default value of 86,400,000 milliseconds (24 hours) is used if @ConnectionDetails.gcGracePeriod@ is not provided
93+
*** @(RTO10b1)@ It is equal to "@ConnectionDetails.objectsGCGracePeriod@":../features#CD2i received in the @CONNECTED@ @ProtocolMessage@
94+
*** @(RTO10b2)@ The grace period value is updated to match the new @ConnectionDetails.objectsGCGracePeriod@ value whenever a new @CONNECTED@ @ProtocolMessage@ is received per "RTN24":../features#RTN24
95+
*** @(RTO10b3)@ A default value of 86,400,000 milliseconds (24 hours) is used if @ConnectionDetails.objectsGCGracePeriod@ is not provided
9696
** @(RTO10c)@ On each check interval:
9797
*** @(RTO10c1)@ For each @LiveObject@ in the @ObjectsPool@:
9898
**** @(RTO10c1a)@ Check if the @LiveObject@ needs to release any resources, see "RTLM19":#RTLM19

0 commit comments

Comments
 (0)