logos-messaging/specs
1
0
Fork 0
mirror of https://github.com/logos-messaging/specs.git synced 2026-05-18 19:09:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

put RateLimitConfig and SdsConfig at node-level

Browse Source
This commit is contained in:
Ivan FB 2026-04-27 16:05:49 +02:00
parent b0967ac293
commit 77b933377e
No known key found for this signature in database
GPG Key ID: DF0C67A04C543270
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
standards/application/reliable-channel-api.md
View File

@ -179,7 +179,8 @@ When an `IEncryption` implementation is provided, it MUST be applied as describe
## The Reliable Channel API ## The Reliable Channel API
This API considers the types defined by [MESSAGING-API](/standards/application/messaging-api.md) plus the following. This API considers the types defined by [MESSAGING-API](/standards/application/messaging-api.md) plus the following (including `SdsConfig` and `RateLimitConfig`).
It also extends `NodeConfig`, defined in [MESSAGING-API](/standards/application/messaging-api.md), with `sds_config` and `rate_limit_config` fields, whose types are defined here.
### Type definitions ### Type definitions
@ -234,22 +235,23 @@ types:
type: MessageEvents type: MessageEvents
description: "Event emitter for reliable message events scoped to this channel." description: "Event emitter for reliable message events scoped to this channel."
ReliableChannelConfig:
type: object
fields:
segmentationConfig:
type: SegmentationConfig
description: "Configuration for message segmentation. Refer to [SEGMENTATION-API](./segmentation-api.md) for details."
sdsConfig:
type: SdsConfig
description: "Configuration for Scalable Data Sync."
rateLimitConfig: rateLimitConfig:
type: RateLimitConfig type: RateLimitConfig
default: DefaultRateLimitConfig default: DefaultRateLimitConfig
description: "Configuration for rate limit management." description: "Configuration for rate limit management."
NodeConfig: # Extends NodeConfig defined in MESSAGING-API
fields:
sds_config:
type: SdsConfig
description: "SDS configuration. See SdsConfig defined in this spec."
rate_limit_config:
type: RateLimitConfig
description: "Rate limiting configuration, including RLN-specific attributes. See RateLimitConfig defined in this spec."
SdsConfig: SdsConfig:
type: object type: object
description: Scalable Data Sync config items.
fields: fields:
persistence: persistence:
type: IPersistence type: IPersistence
@ -269,10 +271,11 @@ types:
RateLimitConfig: RateLimitConfig:
type: object type: object
description: Rate limiting configuration, containing RLN-specific attributes.
fields: fields:
enabled: enabled:
type: bool type: bool
default: true default: false
description: "Whether rate limiting is enforced. SHOULD be true when RLN is active." description: "Whether rate limiting is enforced. SHOULD be true when RLN is active."
epochSizeMs: epochSizeMs:
type: uint type: uint
@ -338,9 +341,6 @@ functions:
- name: contentTopic - name: contentTopic
type: string type: string
description: "The topic this channel listens and sends on. This has routing and filtering connotations." description: "The topic this channel listens and sends on. This has routing and filtering connotations."
- name: channelConfig
type: ReliableChannelConfig
description: "Configuration for the channel."
- name: senderId - name: senderId
type: string type: string
description: "An identifier for this sender. SHOULD be unique and persisted between sessions." description: "An identifier for this sender. SHOULD be unique and persisted between sessions."