MqttClientHelper Class Reference

MQTT client helper. Class instance accessor: MqttClient More...

Public Member Functions
MqttClientHelper	Service (string server)
	Sets the MQTT server to use.
MqttClientHelper	Connect (string clientId)
	Connects to the MQTT server using the default port (1883) and the specified client identifier.
MqttClientHelper	Connect (int port, string clientId)
	Connects to the MQTT server using the specified port and client identifier.
MqttClientHelper	Connect (int port, string clientId, Action< bool > callback=null)
	Connects to the MQTT server using the specified port and client identifier.
MqttClientHelper	Connect (int port, string clientId, Action< MqttClientOptionsBuilder > clientOptionsCallback, Action< bool > callback=null)
	Connects to the MQTT server using the specified port / client identifier and the specified client options.
MqttClientHelper	Disconnect ()
	Disconnects from the MQTT server.
MqttClientHelper	Subscribe (string topic, Action< string, byte[]> callback)
	Subscribes the specified topic.
MqttClientHelper	Unsubscribe (string topic)
	Unsubscribes the specified topic.
MqttClientHelper	Publish (string topic, string message)
	Publish a message to the specified topic.
MqttClientHelper	Publish (string topic, byte[] message)
	Publish a message to the specified topic.
MqttClientHelper	Publish (MqttApplicationMessage applicationMessage)
	Publish a message using advanced options.
MqttClientHelper	UsingWebSockets (bool useWebSocket)
	Connect over WebSocket (default = false).
MqttClientHelper	WithCredentials (string user, string pass)
	Use provided credentials when connecting.
MqttClientHelper	WithTls (bool useTls)
	Sets whether to connect using TLS/SSL or not.

Detailed Description

MQTT client helper. Class instance accessor: MqttClient

Member Function Documentation

Service()

MqttClientHelper Service

(

string

server

)

Sets the MQTT server to use.

Parameters

server

MQTT server address.

Connect() [1/4]

MqttClientHelper Connect

(

string

clientId

)

Connects to the MQTT server using the default port (1883) and the specified client identifier.

Parameters

clientId

The client identifier.

Connect() [2/4]

MqttClientHelper Connect	(	int	port,
		string	clientId
	)

Connects to the MQTT server using the specified port and client identifier.

Parameters

port	MQTT server port.
clientId	The client identifier.

Connect() [3/4]

MqttClientHelper Connect	(	int	port,
		string	clientId,
		Action< bool >	callback = null
	)

Connects to the MQTT server using the specified port and client identifier.

Parameters

port	MQTT server port.
clientId	The client identifier.
callback	Optional callback Action<bool> invoked when the connection status changed (the argument value will be true if connected, false otherwise)

MqttClient .Service(server) .UsingWebSockets(useWebSockets) .Connect(port, clientid, (connected) => { MqttIsConnected = connected; if (connected) { Program.Notify("Connected!"); } else { Program.Notify("Disconnected!"); } });

Connect() [4/4]

MqttClientHelper Connect	(	int	port,
		string	clientId,
		Action< MqttClientOptionsBuilder >	clientOptionsCallback,
		Action< bool >	callback = null
	)

Connects to the MQTT server using the specified port / client identifier and the specified client options.

Parameters

port	MQTT server port.
clientId	The client identifier.
clientOptionsCallback	Callback Action<MqttClientOptionsBuilder> invoked before the connection is established to allow setting advanced connection options. See https://github.com/chkr1011/MQTTnet/wiki/Client for all available options.
callback	Optional callback Action<bool> invoked when the connection status changed (the argument value will be true if connected, false otherwise)

Example:

MqttClient
    .Service(server)
    .UsingWebSockets(useWebSockets)
    .Connect(port, clientid, (options) => {
       options.WithTls(new MqttClientOptionsBuilderTlsParameters {
           UseTls = true,
           CertificateValidationCallback = (X509Certificate x, X509Chain y, SslPolicyErrors z, IMqttClientOptions o) =>
           {
               // TODO: Check conditions of certificate by using above parameters.
               return true;
           }
       });
    }, (connected) => {
    MqttIsConnected = connected;
    if (connected) {
        Program.Notify("Connected!");
    } else {
        Program.Notify("Disconnected!");
    }
});

Subscribe()

MqttClientHelper Subscribe	(	string	topic,
		Action< string, byte[]>	callback
	)

Subscribes the specified topic.

Parameters

topic	Topic name.
callback	Callback for receiving the subscribed topic messages.

Unsubscribe()

MqttClientHelper Unsubscribe

(

string

topic

)

Unsubscribes the specified topic.

Parameters

topic

Topic name.

Publish() [1/3]

MqttClientHelper Publish	(	string	topic,
		string	message
	)

Publish a message to the specified topic.

Parameters

topic	Topic name.
message	Message text.

Publish() [2/3]

MqttClientHelper Publish	(	string	topic,
		byte[]	message
	)

Publish a message to the specified topic.

Parameters

topic	Topic name.
message	Message text as byte array.

Publish() [3/3]

MqttClientHelper Publish

(

MqttApplicationMessage

applicationMessage

)

Publish a message using advanced options.

Parameters

applicationMessage

MqttApplicationMessage instance (See https://github.com/chkr1011/MQTTnet/wiki/Client#publishing-messages for documentation).

UsingWebSockets()

MqttClientHelper UsingWebSockets

(

bool

useWebSocket

)

Connect over WebSocket (default = false).

Returns

NetHelper.

Parameters

useWebSocket

true/false

WithCredentials()

MqttClientHelper WithCredentials	(	string	user,
		string	pass
	)

Use provided credentials when connecting.

Returns

NetHelper.

Parameters

user	Username.
pass	Password.

WithTls()

MqttClientHelper WithTls

(

bool

useTls

)

Sets whether to connect using TLS/SSL or not.

Parameters

useTls

Use TLS/SSL.

Returns

---

The documentation for this class was generated from the following file:

• MqttClientHelper.cs