README
U
Choreo
Tr
Location
Tr
Logger
Tr
Message
T
Backend
- ::get_locationsBackend::get_locations
- ::get_loggerBackend::get_logger
- ::init_atBackend::init_at
T
ChoreoContext
- ::announceChoreoContext::announce
- ::broadcastChoreoContext::broadcast
- ::commChoreoContext::comm
- ::enclaveChoreoContext::enclave
- ::locallyChoreoContext::locally
- ::locally_broadcastChoreoContext::locally_broadcast
T
ConsoleLogger
T
Located
- ::mapLocated::map
T
MuteLogger
T
Unwrapper
- ::unwrapUnwrapper::unwrap
V
make_console_logger
V
make_http_backend
V
make_local_backend
V
make_mute_logger
V
run_choreo

moonchor

Choreographic programming library for MoonBit.

Choreographic

MoonBit

moon add Milky2018/moonchor@0.18.0

Download zip

Author

Milky2018

Version

0.18.0

License

Apache-2.0

Repository

github.com/Milky2018/moonchor.git

Last updated

10 months ago

Downloads

Dependencies

moonbitlang/async0.9.0
moonbitlang/dummy_abort0.2.0

README

#Moonchor: Choreographic Programming Library for MoonBit

#Installation

moon add Milky2018/moonchor

#Examples

Check examples

#Basic APIs

trait Location: Show + Hash {
  name(Self) -> String
}

fn make_local_backend(
  locations : Array[&Location],
  logger~ : &Logger = make_mute_logger()
) -> Backend

async fn run_choreo[T, L : Location](
  backend : Backend,
  choreography : (ChoreoContext) -> T!Async,
  role : L,
  logger? : &Logger
) -> T

For example, you can define some roles/locations by implementing the Location trait:

struct Alice {}
struct Bob {}
impl Location for Alice with name(_) { "Alice" }
impl Location for Bob with name(_) { "Bob" }
let alice : Alice = Alice::{ }
let bob : Bob = Bob::{ }

Define a simple choreography: Alice --msg-> Bob

async fn simple_choreo(ctx: ChoreoContext) -> Unit {
  let msg_at_alice = ctx.locally(alice, fn (_) { "Hello" })
  let msg_at_bob = ctx.comm(alice, bob, msg_at_alice)
  ctx.locally(bob, fn (unwrapper) { println(unwrapper.unwrap(msg_at_bob)) })
}

Then you can run the choreography:

let backend = make_local_backend([alice, bob])
run_choreo!(backend, simple_choreo, alice)
// or  run_choreo!(backend, simple_choreo, bob)

#Todo

#Further Readings

Introduction to Choreographies

HasChor

#
Choreo

source

typealias async (ChoreoContext) -> T as Choreo[T]

Choreography type.

#
Location

source

pub(open) trait Location : Show + Hash {
  name(Self) -> String
}

#
Logger

source

pub trait Logger {
  info(Self, String) -> Unit
}

#
Message

source

pub(open) trait Message : ToJson + @moonbitlang/core/json.FromJson
FromJson {
}

Types that can be (de)serialized. Now only JSON is supported.

#
Backend

source

type Backend

#
Backend::get_locations

source

fn Backend::get_locations(self : Backend) -> Array[&Location]

#
Backend::get_logger

source

fn Backend::get_logger(self : Backend) -> &Logger

#
Backend::init_at

source

async fn[L : Location + Show + Hash] Backend::init_at(self : Backend, role : L) -> Unit

#
ChoreoContext

source

type ChoreoContext

#
ChoreoContext::announce

source

async fn[T : Message + ToJson + @moonbitlang/core/json.FromJson
FromJson, L : Location + Show + Hash] ChoreoContext::announce(self : ChoreoContext, loc : L, targets : Array[&Location], located_value : Located[T, L], subchoreo : async (ChoreoContext, T) -> Unit) -> Unit

Announce a located value to all locations in the given array. This operation takes a subchoreography as an argument.

#
ChoreoContext::broadcast

source

async fn[T : Message + ToJson + @moonbitlang/core/json.FromJson
FromJson, L : Location + Show + Hash] ChoreoContext::broadcast(self : ChoreoContext, loc : L, value : Located[T, L]) -> T

Broadcast a message to all locations.

#
ChoreoContext::comm

source

async fn[T : Message + ToJson + @moonbitlang/core/json.FromJson
FromJson, From : Location + Show + Hash, To : Location + Show + Hash] ChoreoContext::comm(self : ChoreoContext, from : From, to : To, value : Located[T, From]) -> Located[T, To]

Communication between two locations.

#
ChoreoContext::enclave

source

async fn ChoreoContext::enclave(self : ChoreoContext, locations : Array[&Location], subchoreo : async (ChoreoContext) -> Unit) -> Unit

Make an enclave with a subchoreography where broadcast will only spread to the given locations.

#
ChoreoContext::locally

source

fn[T, L : Location + Show + Hash] ChoreoContext::locally(self : ChoreoContext, location : L, computation : (Unwrapper[L]) -> T) -> Located[T, L]

Local computation at the given location.

#
ChoreoContext::locally_broadcast

source

async fn[T : Message + ToJson + @moonbitlang/core/json.FromJson
FromJson, L : Location + Show + Hash] ChoreoContext::locally_broadcast(self : ChoreoContext, loc : L, computation : (Unwrapper[L]) -> T) -> T

Locally compute and then broadcast the result.

#
ConsoleLogger

source

type ConsoleLogger

impl Logger for ConsoleLogger

#
Located

source

type Located[T, _]

Represents a value located at a specific location.

#
Located::map

source

fn[T, L, R] Located::map(self : Located[T, L], f : (T) -> R) -> Located[R, L]

Mapping a located value

#
MuteLogger

source

type MuteLogger

impl Logger for MuteLogger

#
Unwrapper

source

type Unwrapper[_]

The unwrapper is used to unwrap located values in the computation. It is passed to the computation function as the only argument.

#
Unwrapper::unwrap

source

fn[T, L] Unwrapper::unwrap(_ : Unwrapper[L], v : Located[T, L]) -> T

Unwrap a located value.

#
make_console_logger

source

fn make_console_logger() -> ConsoleLogger

#
make_http_backend

source

fn make_http_backend(location_addrs : Array[(&Location, @moonbitlang/async/socket.Addr
Addr)], group : @moonbitlang/async.TaskGroup
TaskGroup[Unit], logger? : &Logger) -> Backend

#
make_local_backend

source

fn make_local_backend(locations : Array[&Location], logger? : &Logger) -> Backend

#
make_mute_logger

source

fn make_mute_logger() -> MuteLogger

#
run_choreo

source

async fn[T, L : Location + Show + Hash] run_choreo(backend : Backend, choreography : async (ChoreoContext) -> T, role : L) -> T

Run a choreography in the given location and backend. Default logger is the backend logger.

Source Files

Site source Report issue Packages Build queue Skills Statistics

moonchor

#Moonchor: Choreographic Programming Library for MoonBit

#Installation

#Examples

#Basic APIs

#Todo

#Further Readings

#Choreo

#Location

#Logger

#Message

#Backend

#Backend::get_locations

#Backend::get_logger

#Backend::init_at

#ChoreoContext

#ChoreoContext::announce

#ChoreoContext::broadcast

#ChoreoContext::comm

#ChoreoContext::enclave

#ChoreoContext::locally

#ChoreoContext::locally_broadcast

#ConsoleLogger

#Located

#Located::map

#MuteLogger

#Unwrapper

#Unwrapper::unwrap

#make_console_logger

#make_http_backend

#make_local_backend

#make_mute_logger

#run_choreo

Source Files

#
Choreo

#
Location

#
Logger

#
Message

#
Backend

#
Backend::get_locations

#
Backend::get_logger

#
Backend::init_at

#
ChoreoContext

#
ChoreoContext::announce

#
ChoreoContext::broadcast

#
ChoreoContext::comm

#
ChoreoContext::enclave

#
ChoreoContext::locally

#
ChoreoContext::locally_broadcast

#
ConsoleLogger

#
Located

#
Located::map

#
MuteLogger

#
Unwrapper

#
Unwrapper::unwrap

#
make_console_logger

#
make_http_backend

#
make_local_backend

#
make_mute_logger

#
run_choreo