category: Architecture

In progress

In order to extend the hosting system, you will need to run your own Stormancer instance (for more information about how to do that, contact our team). This document describes the functionalities that the host must implement.

Host system operations

Here is a list of all the system operations a host must implement to be able to interact correctly with a node.

app.get

Returns scene Templates descriptions and application metadata.

scene.put

Starts a scene on the host if not started

scene.get

Retrieves informations about a scene (ie route, metadata)

scene.delete

Called when the runtime requests the host to stop & remove a scene.

scene.connect

Called when a client try to connect to a scene.

user.disconnect

A client disconnected from the application

user.disconnectScene

A client disconnected from a scene.

node.stop

Request the host to stop.

host.notifyActiveDeploymentChanged

Called when the active deployment changes.

host.status

Returns the host status.

application.configurationChanged

Called when the application's configuration changed and contained as parameter the new configuration json.

Cluster system operation

These system operations can be called by the host to interact with the cluster.

api.ConnectionInfosService.GetConnectionDetails

Get details about a peer identified by id (the peer must be connected to the application.)

api.ApplicationDetailsService.GetApplicationDetails

Get details about the running application