Class MqttServer
public class MqttServer : Disposable, IDisposable- Inheritance
-
MqttServer
- Implements
- Inherited Members
- Extension Methods
Constructors
MqttServer(MqttServerOptions, IEnumerable<IMqttServerAdapter>, IMqttNetLogger)
public MqttServer(MqttServerOptions options, IEnumerable<IMqttServerAdapter> adapters, IMqttNetLogger logger)Parameters
optionsMqttServerOptionsadaptersIEnumerable<IMqttServerAdapter>loggerIMqttNetLogger
Properties
AcceptNewConnections
Gets or sets whether the server will accept new connections. If not, the server will close the connection without any notification (DISCONNECT packet). This feature can be used when the server is shutting down.
public bool AcceptNewConnections { get; set; }Property Value
IsStarted
public bool IsStarted { get; }Property Value
ServerSessionItems
Gives access to the session items which belong to this server. This session items are passed to several events instead of the client session items if the event is caused by the server instead of a client.
public IDictionary ServerSessionItems { get; }Property Value
Methods
DeleteRetainedMessagesAsync()
public Task DeleteRetainedMessagesAsync()Returns
DisconnectClientAsync(string, MqttServerClientDisconnectOptions)
public Task DisconnectClientAsync(string id, MqttServerClientDisconnectOptions options)Parameters
idstringoptionsMqttServerClientDisconnectOptions
Returns
Dispose(bool)
protected override void Dispose(bool disposing)Parameters
disposingbool
GetClientsAsync()
public Task<IList<MqttClientStatus>> GetClientsAsync()Returns
GetRetainedMessageAsync(string)
public Task<MqttApplicationMessage> GetRetainedMessageAsync(string topic)Parameters
topicstring
Returns
GetRetainedMessagesAsync()
public Task<IList<MqttApplicationMessage>> GetRetainedMessagesAsync()Returns
GetSessionsAsync()
public Task<IList<MqttSessionStatus>> GetSessionsAsync()Returns
InjectApplicationMessage(InjectedMqttApplicationMessage, CancellationToken)
public Task InjectApplicationMessage(InjectedMqttApplicationMessage injectedApplicationMessage, CancellationToken cancellationToken = default)Parameters
injectedApplicationMessageInjectedMqttApplicationMessagecancellationTokenCancellationToken
Returns
StartAsync()
public Task StartAsync()Returns
StopAsync(MqttServerStopOptions)
public Task StopAsync(MqttServerStopOptions options)Parameters
optionsMqttServerStopOptions
Returns
SubscribeAsync(string, ICollection<MqttTopicFilter>)
public Task SubscribeAsync(string clientId, ICollection<MqttTopicFilter> topicFilters)Parameters
clientIdstringtopicFiltersICollection<MqttTopicFilter>
Returns
UnsubscribeAsync(string, ICollection<string>)
public Task UnsubscribeAsync(string clientId, ICollection<string> topicFilters)Parameters
clientIdstringtopicFiltersICollection<string>
Returns
UpdateRetainedMessageAsync(MqttApplicationMessage)
public Task UpdateRetainedMessageAsync(MqttApplicationMessage retainedMessage)Parameters
retainedMessageMqttApplicationMessage
Returns
Events
ApplicationMessageEnqueuedOrDroppedAsync
public event Func<ApplicationMessageEnqueuedEventArgs, Task> ApplicationMessageEnqueuedOrDroppedAsyncEvent Type
ApplicationMessageNotConsumedAsync
public event Func<ApplicationMessageNotConsumedEventArgs, Task> ApplicationMessageNotConsumedAsyncEvent Type
ClientAcknowledgedPublishPacketAsync
public event Func<ClientAcknowledgedPublishPacketEventArgs, Task> ClientAcknowledgedPublishPacketAsyncEvent Type
ClientConnectedAsync
public event Func<ClientConnectedEventArgs, Task> ClientConnectedAsyncEvent Type
ClientDisconnectedAsync
public event Func<ClientDisconnectedEventArgs, Task> ClientDisconnectedAsyncEvent Type
ClientSubscribedTopicAsync
public event Func<ClientSubscribedTopicEventArgs, Task> ClientSubscribedTopicAsyncEvent Type
ClientUnsubscribedTopicAsync
public event Func<ClientUnsubscribedTopicEventArgs, Task> ClientUnsubscribedTopicAsyncEvent Type
InterceptingClientEnqueueAsync
public event Func<InterceptingClientApplicationMessageEnqueueEventArgs, Task> InterceptingClientEnqueueAsyncEvent Type
InterceptingInboundPacketAsync
public event Func<InterceptingPacketEventArgs, Task> InterceptingInboundPacketAsyncEvent Type
InterceptingOutboundPacketAsync
public event Func<InterceptingPacketEventArgs, Task> InterceptingOutboundPacketAsyncEvent Type
InterceptingPublishAsync
public event Func<InterceptingPublishEventArgs, Task> InterceptingPublishAsyncEvent Type
InterceptingSubscriptionAsync
public event Func<InterceptingSubscriptionEventArgs, Task> InterceptingSubscriptionAsyncEvent Type
InterceptingUnsubscriptionAsync
public event Func<InterceptingUnsubscriptionEventArgs, Task> InterceptingUnsubscriptionAsyncEvent Type
LoadingRetainedMessageAsync
public event Func<LoadingRetainedMessagesEventArgs, Task> LoadingRetainedMessageAsyncEvent Type
PreparingSessionAsync
public event Func<EventArgs, Task> PreparingSessionAsyncEvent Type
QueuedApplicationMessageOverwrittenAsync
public event Func<QueueMessageOverwrittenEventArgs, Task> QueuedApplicationMessageOverwrittenAsyncEvent Type
RetainedMessageChangedAsync
public event Func<RetainedMessageChangedEventArgs, Task> RetainedMessageChangedAsyncEvent Type
RetainedMessagesClearedAsync
public event Func<EventArgs, Task> RetainedMessagesClearedAsyncEvent Type
SessionDeletedAsync
public event Func<SessionDeletedEventArgs, Task> SessionDeletedAsyncEvent Type
StartedAsync
public event Func<EventArgs, Task> StartedAsyncEvent Type
StoppedAsync
public event Func<EventArgs, Task> StoppedAsyncEvent Type
ValidatingConnectionAsync
public event Func<ValidatingConnectionEventArgs, Task> ValidatingConnectionAsync