#Proton Rabbita

moonbit-community/proton_rabbita maps typed Proton commands and events onto Rabbita Cmd and Sub values. Transport and JSON handling remain owned by moonbit-community/proton_client.

///|
struct PingRequest {
  value : String
} derive(ToJson)

///|
pub  PingRequest with ToJson::{to_json}

///|
struct PingReply {
  value : String
} derive(FromJson)

///|
pub  PingReply with FromJson::{from_json}

///|
test {
  let ping : @proton_contract.Command[PingRequest, PingReply] = @proton_contract.command(
    "ping",
  )
  let request = PingRequest::{ value: "hello", }
  let command = invoke(
    ping,
    request,
    reply => {
      ignore(reply.value)
      @cmd.none
    },
    _error => @cmd.none,
  )
  ignore(command)
}

#Ownership and request effects

subscribe creates a description with no installation side effects. Rabbita installs it in the owning state scope; each installed listener has independent callbacks and cleanup. Use different key values for multiple subscriptions to the same event within one scope. Increase retry to explicitly retry an installation failure. The optional ready command runs after successful listener installation, so initial queries need not race subscription setup.

For reads tied to component/query lifetime, the default scaffold uses its application-local internal/query module. It accepts a typed command, initial input, and an optional invalidation event. Request generations, readiness, cancellation, and stale completion guards are implementation details of that module, not parameters that every application model must maintain.

invoke remains a one-shot effect, suitable for explicit writes; it is not cancelled when a component is removed. Cancelling observation does not roll back backend mutations. invoke and subscribe accept an optional client for isolated tests or browser previews.

The Todo scaffold demonstrates explicit backend bindings, typed business outcomes, managed queries, and separately owned window event destinations.

invoke

source

fn[Request : ToJson, Response : @moonbitlang/core/json.FromJson
FromJson] invoke(command : @moonbit-community/proton_contract.Command
Command[Request, Response], request : Request, success : (Response) -> @moonbit-community/rabbita/cmd.Cmd
Cmd, failure : (@moonbit-community/proton_client.ClientFailure
ClientFailure) -> @moonbit-community/rabbita/cmd.Cmd
Cmd, client? : @moonbit-community/proton_client.Client
Client) -> @moonbit-community/rabbita/cmd.Cmd
Cmd

Invokes a command as a one-shot effect, suitable for explicit writes. This command does not own component-scoped query state.

fn[Payload : @moonbitlang/core/json.FromJson
FromJson] subscribe(event : @moonbit-community/proton_contract.Event
Event[Payload], received : (Payload) -> @moonbit-community/rabbita/cmd.Cmd
Cmd, failure : (@moonbit-community/proton_client.ClientFailure
ClientFailure) -> @moonbit-community/rabbita/cmd.Cmd
Cmd, key? : String, retry? : Int, ready? : @moonbit-community/rabbita/cmd.Cmd
Cmd, client? : @moonbit-community/proton_client.Client
Client) -> @moonbit-community/rabbita/sub.Sub
Sub

Subscribes within the owning Rabbita state scope. Each installed subscription owns its callbacks. Use distinct keys for multiple consumers in one scope. Increment retry to explicitly reinstall a failed subscription.

Source Files

adapter.mbt

Site source Report issue Packages Build queue Skills Statistics

proton_rabbita

#Proton Rabbita

#Ownership and request effects

#invoke

#subscribe

Source Files

invoke

subscribe