Class RPCControllerFactory

Hierarchy

GenericControllerFactory
- RPCControllerFactory

Constructors

constructor

new RPCControllerFactory(ws: WebSocket, devices: ConnectorDevice[]): RPCControllerFactory

Overrides GenericControllerFactory.constructor
- Defined in src/connector/classwrapper/lib.ts:27
Parameters
- ws: WebSocket
- devices: ConnectorDevice[]
Returns RPCControllerFactory

Properties

Protected credential

credential: any

Private deviceConfigs

deviceConfigs: ConnectorDevice[]

Protected deviceaddress

deviceaddress: string

Private devices

devices: null | { id: string; type: string }[] = null

Private rpc

rpc: RPCProvider

Private ws

ws: WebSocket

Methods

authenticate

authenticate(): Promise<void>

Overrides GenericControllerFactory.authenticate
- Defined in src/connector/classwrapper/lib.ts:38
Dummy function. it is okay to call this (for API similarity) but not necessary

Returns Promise<void>

errorPing

errorPing(): Promise<void>

- Defined in src/connector/classwrapper/lib.ts:133
RPC ping which will always fail. Intended to test use only.

Returns Promise<void>

getAuthConfigurator

getAuthConfigurator(targetId: string): RPCAuthConfigurator

Overrides GenericControllerFactory.getAuthConfigurator
- Defined in src/connector/classwrapper/lib.ts:216
Parameters
- targetId: string
Returns RPCAuthConfigurator

getDevices

getDevices(): { id: string; type: string }[]

- Defined in src/connector/classwrapper/lib.ts:110
Fetch available devices in given Mareel Key

Returns { id: string; type: string }[]
Device list

getFirewallConfigurator

getFirewallConfigurator(targetId: string): RPCFirewallConfigurator

Overrides GenericControllerFactory.getFirewallConfigurator
- Defined in src/connector/classwrapper/lib.ts:200
Get FirewallConfigurator using device ID.

Parameters
- targetId: string
  
  device ID
Returns RPCFirewallConfigurator
FirewallConfigurator of given target

getLogman

getLogman(targetId: string): RPCLogman

Overrides GenericControllerFactory.getLogman
- Defined in src/connector/classwrapper/lib.ts:190
Get Logman using device ID.

Parameters
- targetId: string
  
  device ID
Returns RPCLogman
Logman of given target

getNetTester

getNetTester(targetId: string): NetTester

Overrides GenericControllerFactory.getNetTester
- Defined in src/connector/classwrapper/lib.ts:204
Parameters
- targetId: string
Returns NetTester

getProfileManager

getProfileManager(targetId: string): RPCProfileManager

Overrides GenericControllerFactory.getProfileManager
- Defined in src/connector/classwrapper/lib.ts:224
Parameters
- targetId: string
Returns RPCProfileManager

getRouteConfigurator

getRouteConfigurator(targetId: string): RPCRouteConfigurator

Overrides GenericControllerFactory.getRouteConfigurator
- Defined in src/connector/classwrapper/lib.ts:208
Parameters
- targetId: string
Returns RPCRouteConfigurator

getSwitchConfigurator

getSwitchConfigurator(targetId: string): RPCSwitchConfigurator

Overrides GenericControllerFactory.getSwitchConfigurator
- Defined in src/connector/classwrapper/lib.ts:148
Get SwitchConfigurator using device ID.

Parameters
- targetId: string
  
  device ID
Returns RPCSwitchConfigurator
SwitchConfigurator of given target

getSwitchQoS

getSwitchQoS(targetId: string): RPCSwitchQoS

Overrides GenericControllerFactory.getSwitchQoS
- Defined in src/connector/classwrapper/lib.ts:159
Get SwitchQoS using device ID.

Parameters
- targetId: string
  
  device ID
Returns RPCSwitchQoS
SwitchQoS of given target

getTrafficStatMonitor

getTrafficStatMonitor(targetId: string): RPCTrafficStatMonitor

Overrides GenericControllerFactory.getTrafficStatMonitor
- Defined in src/connector/classwrapper/lib.ts:212
Parameters
- targetId: string
Returns RPCTrafficStatMonitor

getVPNConfigurator

getVPNConfigurator(targetId: string): RPCVPNConfigurator

Overrides GenericControllerFactory.getVPNConfigurator
- Defined in src/connector/classwrapper/lib.ts:220
Parameters
- targetId: string
Returns RPCVPNConfigurator

getWLANConfigurator

getWLANConfigurator(targetId: string): RPCWLANConfigurator

Overrides GenericControllerFactory.getWLANConfigurator
- Defined in src/connector/classwrapper/lib.ts:170
Get WLANConfigurator using device ID.

Parameters
- targetId: string
  
  device ID
Returns RPCWLANConfigurator
WLANConfigurator of given target

getWLANUserDeviceStat

getWLANUserDeviceStat(targetId: string): RPCWLANUserDeviceStat

Overrides GenericControllerFactory.getWLANUserDeviceStat
- Defined in src/connector/classwrapper/lib.ts:180
Get WLANUserDeviceStat using device ID.

Parameters
- targetId: string
  
  device ID
Returns RPCWLANUserDeviceStat
WLANUserDeviceStat of given target

init

init(): Promise<void>

Overrides GenericControllerFactory.init
- Defined in src/connector/classwrapper/lib.ts:53
Initialize the RPCControllerFactory

Returns Promise<void>

ping

ping(): Promise<void>

- Defined in src/connector/classwrapper/lib.ts:121
RPC ping. Not network ping.

Returns Promise<void>

refreshAuth

refreshAuth(): Promise<void>

Overrides GenericControllerFactory.refreshAuth
- Defined in src/connector/classwrapper/lib.ts:46
Dummy function. it is okay to call this (for API similarity) but not necessary

Returns Promise<void>

Protected updateCredential

updateCredential(cred: any): void

Inherited from GenericControllerFactory.updateCredential
- Defined in src/driver/generic/lib.ts:23
Parameters
- cred: any
Returns void

updateDevices

updateDevices(devices: ConnectorDevice[]): Promise<boolean>

- Defined in src/connector/classwrapper/lib.ts:94
Update available devices in Mareel Key

Parameters
- devices: ConnectorDevice[]
  
  Update device with credential
Returns Promise<boolean>
- true if daemon restart is required, false if not

Generated using TypeDoc