UrbitEx.API (UrbitEx v0.5.7) View Source

Module with the base functions to start the Urbit Session. Other complex functionality found in other files in this folder.

Link to this section Summary

Functions

Returns an UrbitEx.Session struct, the basic data structure of Urbit session state kept by the UrbitEx.Server Genserver. Create a channel string according to Landscape convention.

Logs in to Urbit. Takes an UrbitEx.Session struct, which includes the server url and +code string. Returns an UrbitEx.Session struct with the cookie and ship name added to it or raises an error if the code is wrong.

Logs out of your Urbit session and kills the GenServer keeping the state. Takes an UrbitEx.Session struct.

Opens the Eyre channel with an empty Airlock request. Takes an UrbitEx.Session struct. called by UrbitEx.Server on start.

Starts Server-side Event Evenstream, called by UrbitEx.Server on start. Takes an UrbitEx.Session struct. Pass a receive loop to the process receiving Event messages to handle them in your program.

Subscribes to Gall apps pushing events to your ship. Events will be sent to the SSE feed.

Adds necessary metadata to PUT requests sent to Airlock. Keeps track of requests to increment request id and acks server-side events received, following Landscape practice. Takes an UrbitEx.Session struct and a list of request bodies for the PUT request.

Link to this section Functions

Returns an UrbitEx.Session struct, the basic data structure of Urbit session state kept by the UrbitEx.Server Genserver. Create a channel string according to Landscape convention.

Logs in to Urbit. Takes an UrbitEx.Session struct, which includes the server url and +code string. Returns an UrbitEx.Session struct with the cookie and ship name added to it or raises an error if the code is wrong.

Logs out of your Urbit session and kills the GenServer keeping the state. Takes an UrbitEx.Session struct.

Opens the Eyre channel with an empty Airlock request. Takes an UrbitEx.Session struct. called by UrbitEx.Server on start.

Starts Server-side Event Evenstream, called by UrbitEx.Server on start. Takes an UrbitEx.Session struct. Pass a receive loop to the process receiving Event messages to handle them in your program.

Link to this function

subscribe(session, subscriptions)

View Source

Subscribes to Gall apps pushing events to your ship. Events will be sent to the SSE feed.

Link to this function

wrap_put(session, items)

View Source

Adds necessary metadata to PUT requests sent to Airlock. Keeps track of requests to increment request id and acks server-side events received, following Landscape practice. Takes an UrbitEx.Session struct and a list of request bodies for the PUT request.