IClientConfiguration Interface
Key value store of service configuration properties provided to the client as part of connection.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export interface IClientConfiguration
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| blockSize | Alpha |
number | Server-defined ideal block size for storing snapshots. | |
| maxMessageSize | Alpha |
number | Max message size the server will accept before requiring chunking. | |
| noopCountFrequency | Alpha |
optional |
number | Set min op frequency with which noops would be sent in case of an active connection which is not sending any op. See noopTimeFrequency for more details. 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value. |
| noopTimeFrequency | Alpha |
optional |
number | noopTimeFrequency & noopCountFrequency control how often a client with "write" connection needs to send noop messages in case no other ops are being sent. Any op (including noops) result in client communicating its reference sequence number to the relay service, which can recalculate MSN based on new info. Clients send noops when either noopTimeFrequency ms elapsed from receiving the last op or when receiving noopCountFrequency ops and only if the client did not have a chance to communicate its reference sequence number via regular ops. 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value. |
Property Details
blockSize
Server-defined ideal block size for storing snapshots.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
blockSize: number;
Type: number
maxMessageSize
Max message size the server will accept before requiring chunking.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
maxMessageSize: number;
Type: number
noopCountFrequency
Set min op frequency with which noops would be sent in case of an active connection which is not sending any op. See noopTimeFrequency for more details. 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
noopCountFrequency?: number;
Type: number
noopTimeFrequency
noopTimeFrequency & noopCountFrequency control how often a client with "write" connection needs to send noop messages in case no other ops are being sent. Any op (including noops) result in client communicating its reference sequence number to the relay service, which can recalculate MSN based on new info. Clients send noops when either noopTimeFrequency ms elapsed from receiving the last op or when receiving noopCountFrequency ops and only if the client did not have a chance to communicate its reference sequence number via regular ops. 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
noopTimeFrequency?: number;
Type: number