Class Port

MQTT port implementation

Hierarchy (View Summary)

Layer.Provider.Port<Client, MQTT.Config>
- Port

Index

Constructors

Accessors

Methods

close start stop

Constructors

constructor

new Port(config: MQTT.Config, logger: LoggerInstance): MQTT.Port
Implementation of functionalities of an MQTT port instance.
Parameters
- config: MQTT.Config
  Port configuration options
- logger: LoggerInstance
  Port logger, to be used internally
Returns MQTT.Port
Overrides Port.constructor

Accessors

client

get client(): MqttClient
Return the underlying port instance

Returns MqttClient
Overrides Layer.Provider.Port.client

state

get state(): boolean
Return the port state as a boolean value, true if the port is available, false in otherwise

Returns boolean
Overrides Layer.Provider.Port.state

Methods

close

close(): Promise<void>
Close the port instance

Returns Promise<void>
Overrides Port.close

start

start(): Promise<void>
Initialize the port instance

Returns Promise<void>
Overrides Port.start

stop

stop(): Promise<void>
Stop the port instance

Returns Promise<void>
Overrides Port.stop