Type Alias LifecycleHooks

All lifecycle hooks (server-side).

type LifecycleHooks = {
    onConnect: OnConnectHook;
    onDisconnect?: OnDisconnectHook;
    onError?: OnErrorHook;
    onPublish?: OnPublishHook;
    onSend: OnSendHook;
    onSubscribe?: OnSubscribeHook;
    onUnsubscribe?: OnUnsubscribeHook;
}

Index

Properties

onConnect onDisconnect? onError? onPublish? onSend onSubscribe? onUnsubscribe?

Properties

onConnect

onConnect: OnConnectHook

Called when client sends CONNECT; return CONNACK

`Optional`onDisconnect

onDisconnect?: OnDisconnectHook

Called when connection closed

`Optional`onError

onError?: OnErrorHook

Called on protocol errors

`Optional`onPublish

onPublish?: OnPublishHook

Called when client sends PUBLISH

onSend

onSend: OnSendHook

Called when packet ready to send to client (required)

`Optional`onSubscribe

onSubscribe?: OnSubscribeHook

Called when client sends SUBSCRIBE; return SUBACK

`Optional`onUnsubscribe

onUnsubscribe?: OnUnsubscribeHook

Called when client sends UNSUBSCRIBE; return UNSUBACK