package emqx.exhook.v2

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc OnProviderLoaded (ProviderLoadedRequest, LoadedResponse)

  exhook.proto:31

  message ProviderLoadedRequest

  exhook.proto:78

  • optional BrokerInfo broker = 1

  • optional RequestMeta meta = 2

  message LoadedResponse

  exhook.proto:277

  • repeated HookSpec hooks = 1

• rpc OnProviderUnloaded (ProviderUnloadedRequest, EmptySuccess)

  exhook.proto:33

  message ProviderUnloadedRequest

  exhook.proto:85

  • optional RequestMeta meta = 1

• rpc OnClientConnect (ClientConnectRequest, EmptySuccess)

  exhook.proto:35

  message ClientConnectRequest

  exhook.proto:90

  • optional ConnInfo conninfo = 1

  • repeated Property props = 2

    MQTT CONNECT packet's properties (MQTT v5.0) It should be empty on MQTT v3.1.1/v3.1 or others protocol

  • optional RequestMeta meta = 3

• rpc OnClientConnack (ClientConnackRequest, EmptySuccess)

  exhook.proto:37

  message ClientConnackRequest

  exhook.proto:102

  • optional ConnInfo conninfo = 1

  • string result_code = 2

  • repeated Property props = 3

  • optional RequestMeta meta = 4

• rpc OnClientConnected (ClientConnectedRequest, EmptySuccess)

  exhook.proto:39

  message ClientConnectedRequest

  exhook.proto:113

  • optional ClientInfo clientinfo = 1

  • optional RequestMeta meta = 2

• rpc OnClientDisconnected (ClientDisconnectedRequest, EmptySuccess)

  exhook.proto:41

  message ClientDisconnectedRequest

  exhook.proto:120

  • optional ClientInfo clientinfo = 1

  • string reason = 2

  • optional RequestMeta meta = 3

• rpc OnClientAuthenticate (ClientAuthenticateRequest, ValuedResponse)

  exhook.proto:43

  message ClientAuthenticateRequest

  exhook.proto:129

  • optional ClientInfo clientinfo = 1

  • bool result = 2

  • optional RequestMeta meta = 3

• rpc OnClientAuthorize (ClientAuthorizeRequest, ValuedResponse)

  exhook.proto:45

  message ClientAuthorizeRequest

  exhook.proto:138

  • optional ClientInfo clientinfo = 1

  • ClientAuthorizeRequest.AuthorizeReqType type = 2

  • string topic = 3

  • bool result = 4

  • optional RequestMeta meta = 5

• rpc OnClientSubscribe (ClientSubscribeRequest, EmptySuccess)

  exhook.proto:47

  message ClientSubscribeRequest

  exhook.proto:158

  • optional ClientInfo clientinfo = 1

  • repeated Property props = 2

  • repeated TopicFilter topic_filters = 3

  • optional RequestMeta meta = 4

• rpc OnClientUnsubscribe (ClientUnsubscribeRequest, EmptySuccess)

  exhook.proto:49

  message ClientUnsubscribeRequest

  exhook.proto:169

  • optional ClientInfo clientinfo = 1

  • repeated Property props = 2

  • repeated TopicFilter topic_filters = 3

  • optional RequestMeta meta = 4

• rpc OnSessionCreated (SessionCreatedRequest, EmptySuccess)

  exhook.proto:51

  message SessionCreatedRequest

  exhook.proto:180

  • optional ClientInfo clientinfo = 1

  • optional RequestMeta meta = 2

• rpc OnSessionSubscribed (SessionSubscribedRequest, EmptySuccess)

  exhook.proto:53

  message SessionSubscribedRequest

  exhook.proto:187

  • optional ClientInfo clientinfo = 1

  • string topic = 2

  • optional SubOpts subopts = 3

  • optional RequestMeta meta = 4

• rpc OnSessionUnsubscribed (SessionUnsubscribedRequest, EmptySuccess)

  exhook.proto:55

  message SessionUnsubscribedRequest

  exhook.proto:198

  • optional ClientInfo clientinfo = 1

  • string topic = 2

  • optional RequestMeta meta = 3

• rpc OnSessionResumed (SessionResumedRequest, EmptySuccess)

  exhook.proto:57

  message SessionResumedRequest

  exhook.proto:207

  • optional ClientInfo clientinfo = 1

  • optional RequestMeta meta = 2

• rpc OnSessionDiscarded (SessionDiscardedRequest, EmptySuccess)

  exhook.proto:59

  message SessionDiscardedRequest

  exhook.proto:214

  • optional ClientInfo clientinfo = 1

  • optional RequestMeta meta = 2

• rpc OnSessionTakenover (SessionTakenoverRequest, EmptySuccess)

  exhook.proto:61

  message SessionTakenoverRequest

  exhook.proto:221

  • optional ClientInfo clientinfo = 1

  • optional RequestMeta meta = 2

• rpc OnSessionTerminated (SessionTerminatedRequest, EmptySuccess)

  exhook.proto:63

  message SessionTerminatedRequest

  exhook.proto:228

  • optional ClientInfo clientinfo = 1

  • string reason = 2

  • optional RequestMeta meta = 3

• rpc OnMessagePublish (MessagePublishRequest, ValuedResponse)

  exhook.proto:65

  message MessagePublishRequest

  exhook.proto:237

  • optional Message message = 1

  • optional RequestMeta meta = 2

• rpc OnMessageDelivered (MessageDeliveredRequest, EmptySuccess)

  exhook.proto:67

  message MessageDeliveredRequest

  exhook.proto:244

  • optional ClientInfo clientinfo = 1

  • optional Message message = 2

  • optional RequestMeta meta = 3

• rpc OnMessageDropped (MessageDroppedRequest, EmptySuccess)

  exhook.proto:69

  message MessageDroppedRequest

  exhook.proto:253

  • optional Message message = 1

  • string reason = 2

  • optional RequestMeta meta = 3

• rpc OnMessageAcked (MessageAckedRequest, EmptySuccess)

  exhook.proto:71

  message MessageAckedRequest

  exhook.proto:262

  • optional ClientInfo clientinfo = 1

  • optional Message message = 2

  • optional RequestMeta meta = 3

Used in: ProviderLoadedRequest

• string version = 1

• string sysdescr = 2

• int64 uptime = 3

• string datetime = 4

Used in: ClientAuthorizeRequest

• PUBLISH = 0

• SUBSCRIBE = 1

Used in: ClientAuthenticateRequest, ClientAuthorizeRequest, ClientConnectedRequest, ClientDisconnectedRequest, ClientSubscribeRequest, ClientUnsubscribeRequest, MessageAckedRequest, MessageDeliveredRequest, SessionCreatedRequest, SessionDiscardedRequest, SessionResumedRequest, SessionSubscribedRequest, SessionTakenoverRequest, SessionTerminatedRequest, SessionUnsubscribedRequest

• string node = 1

• string clientid = 2

• string username = 3

• string password = 4

• string peerhost = 5

• uint32 sockport = 6

• string protocol = 7

• string mountpoint = 8

• bool is_superuser = 9

• bool anonymous = 10

• string cn = 11

  common name of client TLS cert

• string dn = 12

  subject of client TLS cert

Used in: ClientConnackRequest, ClientConnectRequest

• string node = 1

• string clientid = 2

• string username = 3

• string peerhost = 4

• uint32 sockport = 5

• string proto_name = 6

• string proto_ver = 7

• uint32 keepalive = 8

Used as response type in: HookProvider.OnClientConnack, HookProvider.OnClientConnect, HookProvider.OnClientConnected, HookProvider.OnClientDisconnected, HookProvider.OnClientSubscribe, HookProvider.OnClientUnsubscribe, HookProvider.OnMessageAcked, HookProvider.OnMessageDelivered, HookProvider.OnMessageDropped, HookProvider.OnProviderUnloaded, HookProvider.OnSessionCreated, HookProvider.OnSessionDiscarded, HookProvider.OnSessionResumed, HookProvider.OnSessionSubscribed, HookProvider.OnSessionTakenover, HookProvider.OnSessionTerminated, HookProvider.OnSessionUnsubscribed

(message has no fields)

Used in: LoadedResponse

• string name = 1

  The registered hooks name Available value: "client.connect", "client.connack" "client.connected", "client.disconnected" "client.authenticate", "client.authorize" "client.subscribe", "client.unsubscribe" "session.created", "session.subscribed" "session.unsubscribed", "session.resumed" "session.discarded", "session.takenover" "session.terminated" "message.publish", "message.delivered" "message.acked", "message.dropped"

• repeated string topics = 2

  The topic filters for message hooks

Used in: MessageAckedRequest, MessageDeliveredRequest, MessageDroppedRequest, MessagePublishRequest, ValuedResponse

• string node = 1

• string id = 2

• uint32 qos = 3

• string from = 4

• string topic = 5

• bytes payload = 6

• uint64 timestamp = 7

• map<string, string> headers = 8

  The key of header can be: - username: * Readonly * The username of sender client * Value type: utf8 string - protocol: * Readonly * The protocol name of sender client * Value type: string enum with "mqtt", "mqtt-sn", ... - peerhost: * Readonly * The peerhost of sender client * Value type: ip address string - allow_publish: * Writable * Whether to allow the message to be published by emqx * Value type: string enum with "true", "false", default is "true" Notes: All header may be missing, which means that the message does not carry these headers. We can guarantee that clients coming from MQTT, MQTT-SN, CoAP, LwM2M and other natively supported protocol clients will carry these headers, but there is no guarantee that messages published by other means will do, e.g. messages published by HTTP-API

Used in: ClientConnackRequest, ClientConnectRequest, ClientSubscribeRequest, ClientUnsubscribeRequest

• string name = 1

• string value = 2

Used in: ClientAuthenticateRequest, ClientAuthorizeRequest, ClientConnackRequest, ClientConnectRequest, ClientConnectedRequest, ClientDisconnectedRequest, ClientSubscribeRequest, ClientUnsubscribeRequest, MessageAckedRequest, MessageDeliveredRequest, MessageDroppedRequest, MessagePublishRequest, ProviderLoadedRequest, ProviderUnloadedRequest, SessionCreatedRequest, SessionDiscardedRequest, SessionResumedRequest, SessionSubscribedRequest, SessionTakenoverRequest, SessionTerminatedRequest, SessionUnsubscribedRequest

• string node = 1

• string version = 2

• string sysdescr = 3

• string cluster_name = 4

Used in: SessionSubscribedRequest

• uint32 qos = 1

  The QoS level

• string share = 2

  The group name for shared subscription

• uint32 rh = 3

  The Retain Handling option (MQTT v5.0) 0 = Send retained messages at the time of the subscribe 1 = Send retained messages at subscribe only if the subscription does not currently exist 2 = Do not send retained messages at the time of the subscribe

• uint32 rap = 4

  The Retain as Published option (MQTT v5.0) If 1, Application Messages forwarded using this subscription keep the RETAIN flag they were published with. If 0, Application Messages forwarded using this subscription have the RETAIN flag set to 0. Retained messages sent when the subscription is established have the RETAIN flag set to 1.

• uint32 nl = 5

  The No Local option (MQTT v5.0) If the value is 1, Application Messages MUST NOT be forwarded to a connection with a ClientID equal to the ClientID of the publishing

Used in: ClientSubscribeRequest, ClientUnsubscribeRequest

• string name = 1

• uint32 qos = 2

Used as response type in: HookProvider.OnClientAuthenticate, HookProvider.OnClientAuthorize, HookProvider.OnMessagePublish

• ValuedResponse.ResponsedType type = 1

• oneof value

  • bool bool_result = 3

    Boolean result, used on the 'client.authenticate', 'client.authorize' hooks

  • Message message = 4

    Message result, used on the 'message.*' hooks

The responded value type - contiune: Use the responded value and execute the next hook - ignore: Ignore the responded value - stop_and_return: Use the responded value and stop the chain executing

Used in: ValuedResponse

• CONTINUE = 0

• IGNORE = 1

• STOP_AND_RETURN = 2