goSpace

Synopsis

goSpace, a pSpace implementation in Go.

Importing goSpace

To get goSpace, do:

go get -u github.com/pspaces/gospace
cd $GOPATH/src/github.com/pspaces/gospace
git checkout aggregation-policy

To import goSpace into your project, add:

import (
      "github.com/pspaces/gospace"
)

Library

Usage

A space can be created by using NewSpace for creating a local space, or NewRemoteSpace for connecting to a remote space.

To create a space on the localhost, one can do:

spc := gospace.NewSpace("space")

To connect to a remote space with name space, one can do:

spc := gospace.NewRemoteSpace("tcp://example.com/space")

In order to use goSpace efficiently, there are certain rules one needs to know about:

1. An operation acts on a Space structure.
2. Tuples contain values. Templates contain values and types.
3. Ordinary operations such as Put, Get and so forth are blocking operations.
4. Ordinary operations postfixed by a P such as PutP, GetP and so forth are non-blocking operations.
5. Aggregation operations postfixed by a Agg such as PutAgg, GetAgg and so forth are non-blocking operations.
6. Aggregation operations require inclusion of a user defined function f which operate on a Tuple structure and has the signature func(Tuple, Tuple) Tuple.
7. Aggregation operations require that the user defined function f exists on all peers that will use that function.
8. Pattern matching can be achieved by passing a binding variable, that is, passing a pointer to a variabe by adding an & infront of the variable.
9. For Put and PutP operations the parameters must be values. For the remaining operations the parameters must be values or binding variables.
10. Binding variables can only be passed to Get* and Query* operations with any postfix denoted by *.

Space Library

goSpace follows the Space Library Specification. It contains the following operations:

Put(x_1, x_2, ..., x_n)
PutP(x_1, x_2, ..., x_n)
Get(x_1, x_2, ..., x_n)
GetP(x_1, x_2, ..., x_n)
GetAll(x_1, x_2, ..., x_n)
Query(x_1, x_2, ..., x_n)
QueryP(x_1, x_2, ..., x_n)
QueryAll(x_1, x_2, ..., x_n)

Do note that GetAll and QueryAll are non-blocking operators. Blocking version of these operations may come later.

Star Library

goSpace has experimental operators for aggregating tuples in a space. It contains the following operations:

PutAgg(f, x_1, x_2, ..., x_n)
GetAgg(f, x_1, x_2, ..., x_n)
QueryAgg(f, x_1, x_2, ..., x_n)

Do note that these operators are non-blocking. Blocking version of the operations may come later.

Space Library Specification

The specification for the pSpace Space Library can be found here.

Limitations

There are currently some limitations to the implementation:

• Only TCP over IPv4 is supported.
• Gates and space repositories are not supported yet.
• Multiplexing of multiple spaces over a single gate is not supported yet.

Examples

Examples and cases for goSpace can be found here.

Contributing

Want to contribute? See CONTRIBUTING.md.

Authors

See AUTHORS.md.

License

MIT License. See LICENSE.md.