freeboard
Preparing search index...
gateway/src/realtime/SimpleMqttClient
SimpleMqttClient
Class SimpleMqttClient
Hierarchy
EventEmitter
SimpleMqttClient
Index
Constructors
constructor
Properties
broker
Url
username
password
resolved
Address
resolved
Family
tls
Servername
keepalive
Seconds
connect
Timeout
Ms
reconnect
Min
Ms
reconnect
Max
Ms
tls
Options
socket
connected
closed
packet
Id
reconnect
Attempt
reconnect
Timer
connect
Timer
ping
Timer
incoming
Buffer
subscriptions
Methods
next
Packet
Id
reset
Connect
Timer
clear
Connect
Timer
start
Ping
Loop
stop
Ping
Loop
connect
schedule
Reconnect
send
Packet
process
Incoming
Buffer
subscribe
unsubscribe
resubscribe
All
end
Constructors
constructor
new
SimpleMqttClient
(
__namedParameters
:
MqttClientOptions
)
:
SimpleMqttClient
Parameters
__namedParameters
:
MqttClientOptions
Returns
SimpleMqttClient
Properties
broker
Url
brokerUrl
:
string
username
username
:
string
password
password
:
string
resolved
Address
resolvedAddress
:
string
resolved
Family
resolvedFamily
:
number
|
null
tls
Servername
tlsServername
:
string
keepalive
Seconds
keepaliveSeconds
:
number
connect
Timeout
Ms
connectTimeoutMs
:
number
reconnect
Min
Ms
reconnectMinMs
:
number
reconnect
Max
Ms
reconnectMaxMs
:
number
tls
Options
tlsOptions
:
ConnectionOptions
socket
socket
:
MqttSocket
|
null
= null
connected
connected
:
boolean
= false
closed
closed
:
boolean
= false
packet
Id
packetId
:
number
= 1
reconnect
Attempt
reconnectAttempt
:
number
= 0
reconnect
Timer
reconnectTimer
:
Timeout
|
null
= null
connect
Timer
connectTimer
:
Timeout
|
null
= null
ping
Timer
pingTimer
:
Timeout
|
null
= null
incoming
Buffer
incomingBuffer
:
Buffer
<
ArrayBuffer
>
= ...
subscriptions
subscriptions
:
Map
<
any
,
any
>
= ...
Methods
next
Packet
Id
nextPacketId
()
:
number
Returns
number
reset
Connect
Timer
resetConnectTimer
()
:
void
Returns
void
clear
Connect
Timer
clearConnectTimer
()
:
void
Returns
void
start
Ping
Loop
startPingLoop
()
:
void
Returns
void
stop
Ping
Loop
stopPingLoop
()
:
void
Returns
void
connect
connect
()
:
void
Returns
void
schedule
Reconnect
scheduleReconnect
()
:
void
Returns
void
send
Packet
sendPacket
(
packet
:
Buffer
)
:
void
Parameters
packet
:
Buffer
Returns
void
process
Incoming
Buffer
processIncomingBuffer
()
:
void
Returns
void
subscribe
subscribe
(
topic
:
string
,
__namedParameters
?:
MqttSubscriptionOptions
,
callback
?:
(
error
?:
unknown
)
=>
void
,
)
:
void
Parameters
topic
:
string
__namedParameters
:
MqttSubscriptionOptions
= {}
callback
:
(
error
?:
unknown
)
=>
void
= ...
Returns
void
unsubscribe
unsubscribe
(
topic
:
string
,
callback
?:
(
error
?:
unknown
)
=>
void
)
:
void
Parameters
topic
:
string
callback
:
(
error
?:
unknown
)
=>
void
= ...
Returns
void
resubscribe
All
resubscribeAll
()
:
void
Returns
void
end
end
(
force
?:
boolean
)
:
void
Parameters
force
:
boolean
= true
Returns
void
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
broker
Url
username
password
resolved
Address
resolved
Family
tls
Servername
keepalive
Seconds
connect
Timeout
Ms
reconnect
Min
Ms
reconnect
Max
Ms
tls
Options
socket
connected
closed
packet
Id
reconnect
Attempt
reconnect
Timer
connect
Timer
ping
Timer
incoming
Buffer
subscriptions
Methods
next
Packet
Id
reset
Connect
Timer
clear
Connect
Timer
start
Ping
Loop
stop
Ping
Loop
connect
schedule
Reconnect
send
Packet
process
Incoming
Buffer
subscribe
unsubscribe
resubscribe
All
end
freeboard
Loading...