mirror of
https://github.com/logos-messaging/logos-delivery.git
synced 2026-08-01 01:13:16 +00:00
8456245714
Squash of the initial structured-API POC work (1d684bf8..c37dcf84): - WIP: structured Broker API interface + impl (Logos Delivery facade) - Restructured folders; interfaces under logos_delivery/api; MessagingClient and ReliableChannelManager reworked as BrokerInterface/BrokerImplement - API types elevated under logos_delivery/api/types.nim - onelogosdelivery target; wakunode2 / FFI lib build fixes - nim-brokers integration + version bumps; git_version into FFI lib version - compile fixes for tests
49 lines
1.7 KiB
Nim
49 lines
1.7 KiB
Nim
## ReliableChannelManagerInterface — create / close / send on a reliable channel,
|
|
## plus a MessageReceived event (bridged from the channel layer's own
|
|
## ChannelMessageReceivedEvent by the impl).
|
|
|
|
import results, chronos
|
|
import brokers/broker_interface
|
|
|
|
import logos_delivery/api/types
|
|
export types
|
|
|
|
BrokerInterface(API, ReliableChannelManagerInterface):
|
|
EventBroker:
|
|
type ChannelMessageReceivedEvent* = object
|
|
channelId*: ChannelId
|
|
senderId*: SdsParticipantID
|
|
payload*: seq[byte]
|
|
|
|
EventBroker:
|
|
## Emitted when every segment of a channel-level `send()` reached
|
|
## `Confirmed`. Channel-level analogue of `MessageSentEvent`; the
|
|
## `requestId` is the channel-layer parent returned by `send()`.
|
|
type ChannelMessageSentEvent* = object
|
|
channelId*: ChannelId
|
|
requestId*: RequestId
|
|
|
|
EventBroker:
|
|
## Emitted when a channel-level `send()` finalises with at least one
|
|
## segment in `Failed`. Channel-level analogue of `MessageErrorEvent`.
|
|
type ChannelMessageErrorEvent* = object
|
|
channelId*: ChannelId
|
|
requestId*: RequestId
|
|
error*: string
|
|
|
|
RequestBroker:
|
|
# Returns the channel id of the created channel.
|
|
proc createReliableChannel(
|
|
channelId: ChannelId, contentTopic: ContentTopic, senderId: SdsParticipantID
|
|
): Future[Result[ChannelId, string]] {.async.}
|
|
|
|
RequestBroker:
|
|
proc closeChannel(channelId: ChannelId): Future[Result[void, string]] {.async.}
|
|
|
|
RequestBroker:
|
|
# Returns the RequestId in its string form. Named `sendOnChannel` (not `send`)
|
|
# for the global-verb-uniqueness reason noted on MessagingClientInterface.sendMessage.
|
|
proc sendOnChannel(
|
|
channelId: ChannelId, payload: seq[byte], ephemeral: bool
|
|
): Future[Result[RequestId, string]] {.async.}
|