Documentation

Class: ConnectionsList

services/connections-list~ ConnectionsList

new ConnectionsList(app, config, logger, ini)

Create service
Parameters:
Name Type Description
app App Application
config object Configuration
logger Logger Logger service
ini Ini Ini service

Members

<static> provides :string

Service name is 'connectionsList'
Type:
  • string

<static> requires :Array.<string>

Dependencies as constructor arguments
Type:
  • Array.<string>

<static> lifecycle

This service is a singleton

<static> serverSection

Server section delimiter in config

<static> clientSection

Client section delimiter in config

_peer

Retrieve peer server

Methods

get(trackerName)

Get connections
Parameters:
Name Type Description
trackerName string Tracker name
Returns:
Type
object

getImported(trackerName)

Get imported connections
Parameters:
Name Type Description
trackerName string Tracker name
Returns:
Type
object

getAll()

Get the list
Returns:
Type
Map

getAllImported()

Get imports list
Returns:
Type
Map

load()

Load connections list
Returns:
Type
boolean

set(trackerName, list)

Set connections list
Parameters:
Name Type Description
trackerName string Tracker name
list object Connections list

update(trackerName, connectionName, server, connection [, restart])

Create or update connection. Will delete it from imports also
Parameters:
Name Type Argument Default Description
trackerName string Tracker name
connectionName string Connection short name
server boolean Is server connection
connection object Connection info
restart boolean <optional>
 true Restart connection

updatePort(trackerName, connectionName, port)

Update client connection port
Parameters:
Name Type Description
trackerName string Tracker name
connectionName object Connection short name
port string Port number

updateServerName(trackerName, connectionName, server)

Update client connection server
Parameters:
Name Type Description
trackerName string Tracker name
connectionName object Connection short name
server string Daemon name

delete(trackerName, connectionName, server)

Delete connection
Parameters:
Name Type Description
trackerName string Tracker name
connectionName string Connection short name
server boolean Is server connection

save()

Save current connections list
Returns:
Type
boolean

import(trackerName, token, list)

Import connections list
Parameters:
Name Type Description
trackerName string Tracker name
token string Token
list object Connections list

getImport(trackerName, connectionName)

Get imported connection info
Parameters:
Name Type Description
trackerName string Tracker name
connectionName string Connection short name
Returns:
Type
object