Typed asynchronous frontend client for Proton applications.

proton

client

ipc

Download zip

Author

moonbit-community

Version

0.2.9

License

Apache-2.0

Repository

github.com/moonbit-community/proton

Last updated

13 days ago

Downloads

172

Dependencies

moonbitlang/async0.21.2
moonbit-community/proton_contract0.2.9

#Proton Client

moonbit-community/proton_client invokes typed Proton contracts from the active renderer page. It uses the bridge installed by Proton before application scripts run; applications do not construct a client or select a transport.

///|
async fn load_todos {
  let snapshot = @proton_client.invoke(@shared.list_todos, {})
  render(snapshot)
}

Requests are encoded and responses are decoded at the client boundary. Transport, timeout, cancellation, remote execution, and decoding failures are raised as ClientFailure.

ClientFailure

source

pub(all) suberror ClientFailure {
  BridgeUnavailable
  RequestCancelled
  InvalidContract(message~ : String)
  RemoteFailure(code~ : String, message~ : String, detail~ : String?)
  TransportFailure(message~ : String)
  ResponseDecode(message~ : String)
  EventDecode(message~ : String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Failures raised by the typed frontend client.

ClientFailure::equal

source

fn ClientFailure::equal(ClientFailure, ClientFailure) -> Bool

ClientFailure::message

source

fn ClientFailure::message(self : ClientFailure) -> String

Returns a user-facing description of this client failure.

ClientFailure::not_equal

source

fn ClientFailure::not_equal(x : ClientFailure, y : ClientFailure) -> Bool

ClientFailure::output

source

fn ClientFailure::output(self : ClientFailure, logger : &Logger) -> Unit

ClientFailure::to_repr

source

fn ClientFailure::to_repr(ClientFailure) -> @moonbitlang/core/debug.Repr
Repr

ClientFailure::to_string

source

fn ClientFailure::to_string(self : ClientFailure) -> String

Subscription

source

pub struct Subscription {
  closed : Bool
  close_listener : () -> Unit
}

A live event subscription installed on the active renderer page.

Subscription::close

source

fn Subscription::close(self : Subscription) -> Unit

Removes this subscription. Repeated calls have no effect.

invoke

source

async fn[Request : ToJson, Response : @moonbitlang/core/json.FromJson
FromJson] invoke(command : @moonbit-community/proton_contract.Command
Command[Request, Response], request : Request) -> Response raise ClientFailure

Invokes a typed command through the bridge installed on the active page.

fn[Payload : @moonbitlang/core/json.FromJson
FromJson] subscribe(event : @moonbit-community/proton_contract.Event
Event[Payload], received : (Payload) -> Unit, failure : (ClientFailure) -> Unit) -> Subscription raise ClientFailure