MemStorageConnection
Represents a live binding created by Bind() on MemStorageService
that runs a callback whenever a memory-storage key changes.
| Memory category | Instances |
|---|
Member index 1
Description
A MemStorageConnection is the object returned by the Bind() and
BindAndFire() methods of MemStorageService. It wraps the underlying
subscription to a memory-storage key: while the connection is retained, the
callback supplied at bind time is invoked on each update to that key. The
connection is parented to the MemStorageService that created it.
Calling MemStorageConnection:Disconnect(), or allowing the object to
be destroyed, detaches it and stops any further callbacks.
History 5
- 573 Change ReturnType of Disconnect from void to null
- 462 Change ThreadSafety of Disconnect from to Unsafe
- 398 Change Security of Disconnect from RobloxScriptSecurity to PluginSecurity
- 397 Add Disconnect
- 397 Add MemStorageConnection
Members 1
Disconnect
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
Detaches the connection from its parent MemStorageService and disconnects the underlying subscription, so the callback supplied when the connection was created is no longer invoked when the key is updated. This is also called automatically when the MemStorageConnection is destroyed. Once disconnected, a connection cannot be re-established; bind again to resume receiving updates.
| Security | PluginSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 573 Change ReturnType of Disconnect from void to null
- 462 Change ThreadSafety of Disconnect from to Unsafe
- 398 Change Security of Disconnect from RobloxScriptSecurity to PluginSecurity
- 397 Add Disconnect