Previous: , Up: Netlayers   [Contents][Index]

7.5.4 Prelay Utils

The Prelay (Unencrypted, v0) netlayer is built around there being a Prelay server which accepts connections, allowing the controlling user to open new connections and facilitates passing messages back and forth for established connections. This Prelay server must be setup somewhere accessible on the network it operates.

Goblins comes with a set of Prelay utils which are designed to offer one way to setup the server with multiple accounts. There are many ways this could be done, however other Prelay server designs are left to the reader to build. The Prelay utils are available in the (goblins ocapn netlayer prelay-utils) module, and an example of how to use them to run a daemon can be found in examples/prelay-server.scm, as shipped with Spritely Goblins.

(goblins ocapn netlayer prelay-utils) provides the following functions:

Constructor: ^prelay-admin bcom enliven register

This constructs an admin actor to manage prelay accounts. This is to be used on the “server” side.

It takes two arguments: enliven which is a facet object that when provided the symbol 'enliven followed by a OCapN sturdyref returns a vow of the enlivened sturdyref. It also takes register which when provided an object will make that object available at a given sturdyref and return that to the caller. Both of these are likely facets of the Mycapn object.

The admin object itself has two methods, those are:

  • add-account which takes a name of an account and returns a sturdyref. This sturdyref is designed to be given to the user who is controlling the relay account. The user can then enliven said sturdyref and send a message to the enlivened object to get the prelay endpoint and prelay controller objects.
  • get-accounts which provides a list of all account names registered with this prelay admin.
Procedure: fetch-and-spawn-prelay-netlayer account-setup-sref [#:netlayer] [#:mycapn]

This takes a account setup sturdyref retrieved from the add-account method on the Prelay admin and returns a promise resolving to a freshly spawned Prelay netlayer. This is to be used on the “client” side.

By default when using the relay over Tor Onion Services netlayer or TCP + TLS netlayer it will setup a new netlayer to use to speak with the relay over. If a different netlayer is to be used, or any of the default options need changing, the netlayer should be setup beforehand and passed in through the #:netlayer argument.

By default it will create a new mycapn, however if one already exists for the netlayer specified in #:netlayer, then you can pass that in with the #:mycapn argument.

Previous: Prelay (Unencrypted, v0), Up: Netlayers   [Contents][Index]