proper name for event objs

This commit is contained in:
Ivan FB 2026-04-23 22:05:41 +02:00
parent bfaf91d02b
commit 2fc897e655
No known key found for this signature in database
GPG Key ID: DF0C67A04C543270

View File

@ -203,7 +203,7 @@ types:
type: string type: string
description: "Unique identifier" description: "Unique identifier"
messageEvents: messageEvents:
type: ReliableMessageEvents type: MessageEvents
description: "Event emitter for message-related events on this channel" description: "Event emitter for message-related events on this channel"
syncStatus: syncStatus:
type: SyncStatus type: SyncStatus
@ -345,7 +345,7 @@ When an `IEncryption` implementation is provided, it MUST be applied as describe
```yaml ```yaml
types: types:
ReliableMessageReceivedEvent: EventMessageReceived:
type: object type: object
description: "Event emitted when a complete message has been received and reassembled." description: "Event emitted when a complete message has been received and reassembled."
fields: fields:
@ -359,7 +359,7 @@ types:
type: array<byte> type: array<byte>
description: "The decrypted and reassembled message payload" description: "The decrypted and reassembled message payload"
ReliableMessageSentEvent: EventReliableMessageSent:
type: object type: object
description: "Event emitted when all chunks of a message have been acknowledged by the network." description: "Event emitted when all chunks of a message have been acknowledged by the network."
fields: fields:
@ -367,7 +367,7 @@ types:
type: RequestId type: RequestId
description: "The request ID associated with the sent message" description: "The request ID associated with the sent message"
ReliableMessageSendErrorEvent: EventMessageSendError:
type: object type: object
description: "Event emitted when a message send operation fails after exhausting retransmission attempts." description: "Event emitted when a message send operation fails after exhausting retransmission attempts."
fields: fields:
@ -378,7 +378,7 @@ types:
type: string type: string
description: "Error message describing what went wrong" description: "Error message describing what went wrong"
ReliableMessageAcknowledgedEvent: EventMessageAcknowledged:
type: object type: object
description: "Event emitted when the message has been definitively acknowledged via causal history." description: "Event emitted when the message has been definitively acknowledged via causal history."
fields: fields:
@ -386,7 +386,7 @@ types:
type: RequestId type: RequestId
description: "The request ID associated with the acknowledged message" description: "The request ID associated with the acknowledged message"
ReliableIrretrievableMessageEvent: EventIrretrievableMessage:
type: object type: object
description: "Event emitted when a missing message could not be retrieved after all store-query attempts." description: "Event emitted when a missing message could not be retrieved after all store-query attempts."
fields: fields:
@ -394,7 +394,7 @@ types:
type: RequestId type: RequestId
description: "The request ID of the unrecoverable message" description: "The request ID of the unrecoverable message"
ReliableSyncStatusEvent: EventSyncStatus:
type: object type: object
description: "Event emitted when the channel's sync status transitions between 'synced' and 'syncing'." description: "Event emitted when the channel's sync status transitions between 'synced' and 'syncing'."
fields: fields:
@ -405,24 +405,24 @@ types:
type: SyncStatusDetail type: SyncStatusDetail
description: "Counters describing the current sync state" description: "Counters describing the current sync state"
ReliableMessageEvents: MessageEvents:
type: event_emitter type: event_emitter
description: "Event source for reliable message events on a channel" description: "Event source for reliable message events on a channel"
events: events:
"reliable:message:received": "reliable:message:received":
type: ReliableMessageReceivedEvent type: EventMessageReceived
"reliable:message:sent": "reliable:message:sent":
type: ReliableMessageSentEvent type: EventMessageSent
"reliable:message:acknowledged": "reliable:message:acknowledged":
type: ReliableMessageAcknowledgedEvent type: EventMessageAcknowledged
description: "Message definitively acknowledged via causal history." description: "Message definitively acknowledged via causal history."
"reliable:message:send-error": "reliable:message:send-error":
type: ReliableMessageSendErrorEvent type: EventMessageSendError
"reliable:message:irretrievable": "reliable:message:irretrievable":
type: ReliableIrretrievableMessageEvent type: EventIrretrievableMessage
description: "Missing message could not be retrieved after all store-query attempts." description: "Missing message could not be retrieved after all store-query attempts."
"reliable:sync:status": "reliable:sync:status":
type: ReliableSyncStatusEvent type: EventSyncStatus
description: "Channel sync status changed between 'synced' and 'syncing'." description: "Channel sync status changed between 'synced' and 'syncing'."
``` ```