MqttConnectEventRequest Class

Reference

Definition

Namespace:: Microsoft.Azure.WebPubSub.Common

Assembly:: Microsoft.Azure.WebPubSub.Common.dll

Package:: Microsoft.Azure.WebPubSub.Common v1.4.0

Source:: MqttConnectEventRequest.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

MQTT Connect event request. It's sent when a MQTT client connects to the service.

[System.Runtime.Serialization.DataContract]
public class MqttConnectEventRequest : Microsoft.Azure.WebPubSub.Common.ConnectEventRequest

[<System.Runtime.Serialization.DataContract>]
type MqttConnectEventRequest = class
    inherit ConnectEventRequest

Public Class MqttConnectEventRequest
Inherits ConnectEventRequest

Inheritance: Object

WebPubSubEventRequest

ConnectEventRequest
MqttConnectEventRequest

Attributes: DataContractAttribute

Constructors

MqttConnectEventRequest(MqttConnectionContext, IReadOnlyDictionary<String, String[]>, IReadOnlyDictionary<String,String[]>, IEnumerable<WebPubSubClientCertificate>, IReadOnlyDictionary<String,String[]>, MqttConnectProperties)

Creates a new instance of MqttConnectEventRequest.

Properties

Claims	User Claims. (Inherited from ConnectEventRequest)
ClientCertificates	Client certificates. (Inherited from ConnectEventRequest)
ConnectionContext	Connection context contains connection metadata following CloudEvents. (Inherited from WebPubSubEventRequest)
Headers	Request headers. (Inherited from ConnectEventRequest)
Mqtt	The properties of the MQTT CONNECT packet.
Query	Request query. (Inherited from ConnectEventRequest)
Subprotocols	Supported subprotocols. (Inherited from ConnectEventRequest)

Methods

CreateErrorResponse(WebPubSubErrorCode, String)	Create EventErrorResponse. Methods works for Function Extensions. And AspNetCore SDK Hub methods can directly throw exception for error cases. (Inherited from ConnectEventRequest)
CreateMqttResponse(String, IEnumerable<String>, IEnumerable<String>)	Create MqttConnectEventResponse.
CreateMqttV311ErrorResponse(MqttV311ConnectReturnCode, String)	Creates error response for MQTT protocol 3.1.1.
CreateMqttV50ErrorResponse(MqttV500ConnectReasonCode, String)	Creates error response for MQTT protocol 5.0.
CreateResponse(String, IEnumerable<String>, String, IEnumerable<String>)	Create ConnectEventResponse. (Inherited from ConnectEventRequest)

Applies to

Share via