https://github.com/d-plaindoux/magnet

Javascript Multi-Agent framework
https://github.com/d-plaindoux/magnet

agent asynchronous coordinator message-passing promise

Last synced: 11 days ago
JSON representation

Javascript Multi-Agent framework

• Host: GitHub
• URL: https://github.com/d-plaindoux/magnet
• Owner: d-plaindoux
• License: lgpl-2.1
• Created: 2016-11-30T06:35:56.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T10:04:56.000Z (almost 2 years ago)
• Last Synced: 2023-03-12T10:07:09.808Z (over 1 year ago)
• Topics: agent, asynchronous, coordinator, message-passing, promise
• Language: JavaScript
• Homepage:
• Size: 442 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Magnet

[![Build Status](https://travis-ci.org/d-plaindoux/magnet.svg?branch=master)](https://travis-ci.org/d-plaindoux/magnet)

[![Coverage Status](https://coveralls.io/repos/github/d-plaindoux/magnet/badge.svg?branch=master)](https://coveralls.io/github/d-plaindoux/magnet?branch=master)

[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

## Introduction

Magnet is a simple library dedicated to asynchronous and distributed execution

based on agent management thanks to a coordinator component.

### Hello World!

An agent has the capability to communicate with a model. Such model can

be a simple class or a function. Finally a model can interact with other

agent or can simply create or manage existing agents.

#### The Functional style

```javascript

function hello(request, response) {

    response.success("Hello " + request + "!");

}

```

Then such function can be simply managed by an agent and hosted by a given

coordinator.

```javascript

const aCoordinator = coordinator();

aCoordinator.agent("hello").bind(hello);

```

#### The Object-Oriented style

```javascript

class Hello {

    accept(request, response) {

        response.success("Hello " + request + "!");

    }

}

```

```javascript

const aCoordinator = coordinator();

aCoordinator.agent("hello").bind(new Hello());

```

#### Asking `World` job to the `hello` agent

```javascript

// ask returns a Promise

aCoordinator.ask("hello", "World").then(console.log);

```

Using explicit response handler bound to the promise:

```javascript

const aResponse = response(console.log);

aResponse.bind(aCoordinator.ask("hello", "World"));

```

## Coordinator physiology

### Agent creation and life cycle

Create/Retrieve an agent using its name.

```

coordinator.agent :: string -> Agent

```

Destroy an agent using its name.

```

coordinator.dispose :: string -> unit

```

### Agent interaction

Ask an identified agent. This returns a promise.

```

coordinator.ask :: (string,'a) -> Promise 'b'

```

## License

Copyright (C)2017 D. Plaindoux.

This program is  free software; you can redistribute  it and/or modify

it  under the  terms  of  the GNU  Lesser  General  Public License  as

published by  the Free Software  Foundation; either version 2,  or (at

your option) any later version.

This program  is distributed in the  hope that it will  be useful, but

WITHOUT   ANY  WARRANTY;   without  even   the  implied   warranty  of

MERCHANTABILITY  or FITNESS  FOR  A PARTICULAR  PURPOSE.  See the  GNU

Lesser General Public License for more details.

You  should have  received a  copy of  the GNU  Lesser General  Public

License along with  this program; see the file COPYING.  If not, write

to the  Free Software Foundation,  675 Mass Ave, Cambridge,  MA 02139,

USA.