Typedef
| Static Public Summary | ||
| public |
A configuration object used to build an overlay |
|
Static Public
public OverlayConfig: Object source
A configuration object used to build an overlay
Properties:
| Name | Type | Attribute | Description |
| name | string | Name of the overlay, used to access it with NetworkManager#overlay |
|
| class | function | function used to instanciate the constructor with |
|
| options | Object | Dedicated options used to build the overlay |
|
| options.protocol | string | Name of the protocol run by the overlay |
|
| options.signaling | Object | Options used to configure the interactions with the signaling server |
|
| options.signaling.address | string | URL of the signaling server |
|
| options.signaling.room | string | Name of the room in which the application run |
Example:
{
name: 'latencies-overlay',
class: LatenciesOverlay,
options: {
protocol: 'foglet-latencies-overlay'
}
}