Search
Preparing search index...
The search index is not available
@iotize/device-com-mqtt.js
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
MqttRelayProtocol
Class MqttRelayProtocol
Hierarchy
MqttProtocol
MqttRelayProtocol
Index
Constructors
constructor
Properties
_message
Converter
_receive
Stream
last
Message
request
Counter
session
Id
TAG
Accessors
client
Options
options
Methods
_abort
Connect
_connect
_disconnect
connect
ToBroker
read
read
One
Value
set
Credentials
set
Default
Config
set
Message
Converter
subscribe
ToTopics
write
Constructors
constructor
new
Mqtt
Relay
Protocol
(
options
?:
MqttProtocolOptions
)
:
MqttRelayProtocol
Parameters
Optional
options:
MqttProtocolOptions
Returns
MqttRelayProtocol
Properties
Protected
_message
Converter
_message
Converter
:
MqttRelayMessageConverter
Protected
_receive
Stream
_receive
Stream
:
Subject
<
Uint8Array
>
Protected
Optional
last
Message
last
Message
:
MqttRelayMessagePayload
request
Counter
request
Counter
:
number
= 1
session
Id
session
Id
:
number
= 1
Static
Protected
TAG
TAG
:
string
= "MqttRelayProtocol"
Accessors
client
Options
get
clientOptions
(
)
:
IClientOptions
Returns
IClientOptions
options
get
options
(
)
:
MqttProtocolOptions
Returns
MqttProtocolOptions
Methods
_abort
Connect
_abort
Connect
(
)
:
void
Returns
void
_connect
_connect
(
options
?:
ComProtocolConnectOptions
)
:
Observable
<
any
>
Parameters
Optional
options:
ComProtocolConnectOptions
Returns
Observable
<
any
>
_disconnect
_disconnect
(
options
?:
ComProtocolDisconnectOptions
)
:
Observable
<
any
>
Parameters
Optional
options:
ComProtocolDisconnectOptions
Returns
Observable
<
any
>
connect
ToBroker
connect
ToBroker
(
)
:
Promise
<
void
>
Wait until the actual connection to the broker or time out.
Returns
Promise
<
void
>
read
read
(
)
:
Promise
<
Uint8Array
>
Returns
Promise
<
Uint8Array
>
read
One
Value
read
One
Value
(
)
:
Promise
<
Uint8Array
>
Returns
Promise
<
Uint8Array
>
set
Credentials
set
Credentials
(
credentials
:
object
)
:
this
Parameters
credentials:
object
password
:
string
username
:
string
Returns
this
set
Default
Config
set
Default
Config
(
)
:
void
Returns
void
set
Message
Converter
set
Message
Converter
(
converter
:
MqttRelayMessageConverter
)
:
void
Parameters
converter:
MqttRelayMessageConverter
Returns
void
subscribe
ToTopics
subscribe
ToTopics
(
topics
?:
string
|
string
[]
)
:
Promise
<
ISubscriptionGrant
[]
>
Parameters
Optional
topics:
string
|
string
[]
Returns
Promise
<
ISubscriptionGrant
[]
>
write
write
(
data
:
Uint8Array
)
:
Promise
<
Packet
>
Parameters
data:
Uint8Array
Returns
Promise
<
Packet
>
Globals
Logger
Mqtt
Client
Listener
Mqtt
Protocol
Mqtt
Relay
Message
Converter
Mqtt
Relay
Protocol
constructor
_message
Converter
_receive
Stream
last
Message
request
Counter
session
Id
TAG
client
Options
options
_abort
Connect
_connect
_disconnect
connect
ToBroker
read
read
One
Value
set
Credentials
set
Default
Config
set
Message
Converter
subscribe
ToTopics
write
Mqtt
Relay
Protocol
Factory
Topic
Builder
Message
Type
Mqtt
Protocol
Options
Mqtt
Relay
Message
Payload
Generated using
TypeDoc
Wait until the actual connection to the broker or time out.