Frontend API

@Injectable() export class SocketService

This service provides a websocket connexion from this frontend to the backend. The websocket is used to connect the user interface to a specific project, selected on the Workspace-chooser view.

The methods to communicate with the backend about workflow changes are implemented in this class.

Only one instance must exists at runtime.

Created by antoine on 15/06/2017.

connect (address: string, workspaceId: string)

Connect the websocket to the given address and subprotocol and set the onopen, onmessage, onerror and onclose methods on the WebSocket instance.

• Parameters:
  • address — the absolute URL of the backend
  • workspaceId — the id of the workspace to connect to

close ()

Close the WebSocket connexion. After the socket is closed, it is impossible to communicate with the server about the project.

async reconnectSocket ()

Reconnect the WebSocket to the already configured address and workspace.

• Returns: Promise<void> —

handleClose (ev: CloseEvent)

Handle the CloseEvent from the WebSocket instance.

• Parameters: ev — the event to handle

async handleOpen (ev: Event)

Handle the open event of the WebSocket.

Right after connexion, it request the list of components for the selected workspace and the content of the root directory of the project.

• Parameters: ev —
• Returns: Promise<void> —

handleMessage (ev: MessageEvent)

Handle the message received on the WebSocket.

• Parameters: ev — the event containing the message

handleError (ev: ErrorEvent)

Handle the error event of the WebSocket.

• Parameters: ev — the event to handle

setEventHub (eventHub: any): void

Set the eventhub instance. The eventhub is a GoldenLayout component used as a hub to centralize the communication between the views.

• Parameters: eventHub — the new hub to use

async networkGetStatus ()

Send a network:getstatus message.

https://flowbased.github.io/fbp-protocol/#network-getstatus

• Returns: Promise<void> —

sendAddNode (node: Node)

Send a “graph:addnode” message. To use after the user added a node on the graph.

https://flowbased.github.io/fbp-protocol/#graph-addnode

• Parameters: node — the added node

sendRemoveNode (node: Node)

Send a “graph:removenode” message. To use after the user removed a node from the graph.

https://flowbased.github.io/fbp-protocol/#graph-removenode

• Parameters: node — the removed node

sendChangeNode (node: Node)

Send a “graph:changenode” message. To use after the user changed any metadata of the node.

https://flowbased.github.io/fbp-protocol/#graph-updatenode

• Parameters: node — the modified node

sendAddEdge (edge: Edge)

Send a “graph:addedge” message. To use after the user added an edge on the graph.

https://flowbased.github.io/fbp-protocol/#graph-addedge

• Parameters: edge — the added edge

sendRemoveEdge (edge: Edge)

Send a “graph:removeedge” message. To use after the user removed an edge on the graph.

https://flowbased.github.io/fbp-protocol/#graph-removeedge

• Parameters: edge — the removed edge

sendChangeEdge (edge: Edge)

Send a “graph:changeedge” message. To use after the user changed the metadata of an edge.

https://flowbased.github.io/fbp-protocol/#graph-changeedge

• Parameters: edge — the udpated edge

async sendFileExplorerGetNodesMsg ()

Send a “filexplorer:getnodes” message. Will received a message containing the file structure of the root directory of the workspace as a tree.

• Returns: Promise<void> —

buildPayloadForEdge (edge: Edge): Object

Create a FBPMessage compliant payload object for the given Edge

• Parameters: edge — the edge to use
• Returns: Object — the FBPMessage compliant payload object

sleep(ms: number)

Pause the execution of a function for the given amount of milliseconds.

• Parameters: ms — the duration of the sleep, in milliseconds
• Returns: Promise<T> —