import Network from 'foglet-core/src/network/network.js'

public class | source

Network

Network represent a network layer with three main components:

The network itself, which can be a RPS, like SprayAdapter, or an overlay, like LatenciesOverlay.
The signaling part, which is a connection with a signaling server used by peers to join the network.
The communication part, which allow a peer to send message in the network using broadcast or unicast channels.

Constructor Summary

Public Constructor
public	constructor(network: AbstractNetwork, signaling: Object, protocol: string) Constructor

Public Members
public get	communication: Communication: * The communication component
public get	network: AbstractNetwork: * The network component
public get	protocol: [type]: * Get the protocol of the network
public get	signaling: Signaling: * The signaling component

Public Methods
public	use(middleware: Object, priority: Number): void Register a middleware, with an optional priority

Constructor

Name	Type	Attribute	Description
network	AbstractNetwork		The network layer
signaling	Object		Options used to build the signaling part
signaling.address	string		URL of the signaling server
signaling.room	string		Name of the room in which the application run
protocol	string		Name of the protocol run by the network

The communication component

The communication component

The network component

The network component

Get the protocol of the network

[type]

[description]

The signaling component

The signaling component

Name	Type	Attribute	Description
middleware	Object		The middleware to register
middleware.in	function		Function applied on middleware input
middleware.out	function		Function applied on middleware output
priority	Number	optional default: 0	(optional) The middleware priority

void