Home Reference Source

References

summary
public

C Foglet

Foglet is the main class used to build fog computing applications.

fprotocol

summary
public

An AnswerQueue stamp messages with unique ids and allow peers to answer to service calls using the reply and reject helpers.

public abstract

FogletProtocol represent an abstract protocol.

public

F define(protocolName: string): function

Create a function that evaluates a tagged template to create a new subclass of FogletProtocol that implements the protocol described in the template.

fprotocol/builders

summary
public abstract

An AbstractBuilder defines an abstract class capable of builiding a service method.

public

A builder specialized for broadcast services

public

An InitBuilder build the _init method for a protocol prototype.

public

A ServiceBuilder build a service into the prototype of a protocol, including the service method, the handler & the possible hooks.

public

A builder specialized for unicast services

network

summary
public

A NetworkManager manage several distinct Network instances, i.e.

public

Network represent a network layer with three main components:

  • The network itself, which can be a RPS, like SprayAdapter, or an overlay, like LatenciesOverlay.
public

A configuration object used to build an overlay

network/abstract

summary
public abstract

AbstractNetwork represents an abstract network layer

public abstract
this class was deprecated. This class is awaiting imminent DOOOM, please use {@link TManOverlay} instead

AbstractOverlay represents an abstract overlay

public abstract

A TManOverlay is an abstract network used to build overlay based on the TMan network over WebRTC.

network/communication

summary
public

Communication is a facade to send messages to peers in a network using unicast or broadcast channels.

network/communication/abstract

summary
public abstract

AbstractBroadcast represents an abstract broadcast protocol.

public abstract

AbstractUnicast represents an abstract unicast protocol.

public abstract

CommunicationProtocol represents an abstract communication protocol.

network/communication/broadcast

summary
public

Broadcast represent the base implementation of a broadcast protocol for the foglet library.

network/communication/stream

summary
public

A StreamMessage enable to receive data streamed using a StreamRequest.

public

A StreamRequest enable to stream data to a peer using a push-based API.

network/communication/unicast

summary
public

Unicast represent the base implementation of an unicast protocol for the foglet library.

network/rps

summary
public

CyclonAdapter adapts the usage of a Cyclon RPS in the foglet library.

public

SprayAdapter adapts the usage of a Spray RPS in the foglet library.

network/rps/cyclon

summary
public

C Cyclon: [type]

Implementation of CYCLON: Inexpensive Membership Management for Unstructured P2P Overlays Spyros Voulgaris,1,2 Daniela Gavidia,1 and Maarten van Steen1 @article{voulgaris2005cyclon, title={Cyclon: Inexpensive membership management for unstructured p2p overlays}, author={Voulgaris, Spyros and Gavidia, Daniela and Van Steen, Maarten}, journal={Journal of Network and Systems Management}, volume={13}, number={2}, pages={197--217}, year={2005}, publisher={Springer} }

public

network/signaling

summary
public

Signaling is an interface with a signaling server with the same APi as foglet-signaling-server {@see https://github.com/RAN3D/foglet-signaling-server}.

utils

summary
public

C Media

Media Stream Manager If using Video/audio stream for all users: use the broadcast primitive (Data Channel) If using Video/audio stream for only one user, use the unicast primitive (Streaming) But pay attention that using unicast method, when a shuffling occur the connection might diseapear.

public

A Middleware registry coordintaes middleware in a foglet application

public
public