MqttProtocol (Spring Boot Protocol 2.1.4 API)

java.lang.Object
- com.github.netty.core.AbstractProtocol
- - com.github.netty.protocol.MqttProtocol

所有已实现的接口:

Ordered, ProtocolHandler, ServerListener
```
public class MqttProtocol
extends AbstractProtocol
```
Internet of things messaging protocol

作者:

wangzihao 2018/12/5/005

字段概要
- 从接口继承的字段 com.github.netty.core.Ordered
  COMPARATOR

构造器概要

构造器
构造器和说明

MqttProtocol()

MqttProtocol(int messageMaxLength, int nettyReaderIdleTimeSeconds, int autoFlushIdleTime)

构造器
构造器和说明
`MqttProtocol()`
`MqttProtocol(int messageMaxLength, int nettyReaderIdleTimeSeconds, int autoFlushIdleTime)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addInterceptHandler(InterceptHandler interceptHandler)`
`void`	`addPipeline(io.netty.channel.Channel channel)` add protocol pipeline support
`boolean`	`canSupport(io.netty.buffer.ByteBuf msg)` Support protocol
`String`	`getMetricsLibratoEmail()`
`String`	`getMetricsLibratoSource()`
`String`	`getMetricsLibratoToken()`
`int`	`getOrder()` default Priority order 0
`String`	`getProtocolName()` Get the protocol name
`void`	`internalPublish(io.netty.handler.codec.mqtt.MqttPublishMessage msg, String clientId)`
`boolean`	`isEnableMetrics()`
`<T extends AbstractNettyServer> void`	`onServerStart(T server)`
`<T extends AbstractNettyServer> void`	`onServerStop(T server)`
`void`	`removeInterceptHandler(InterceptHandler interceptHandler)`
`void`	`setEnableMetrics(boolean enableMetrics)`
`void`	`setMetricsLibratoEmail(String metricsLibratoEmail)`
`void`	`setMetricsLibratoSource(String metricsLibratoSource)`
`void`	`setMetricsLibratoToken(String metricsLibratoToken)`

从类继承的方法 com.github.netty.core.AbstractProtocol
getAutoFlushIdleMs, setAutoFlushIdleMs, toString

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.github.netty.core.ProtocolHandler
canSupport

从接口继承的方法 com.github.netty.core.ServerListener
config

从接口继承的方法 com.github.netty.core.Ordered
main

- 构造器详细资料
  - MqttProtocol
```
public MqttProtocol()
```
  - MqttProtocol
```
public MqttProtocol(int messageMaxLength,
                    int nettyReaderIdleTimeSeconds,
                    int autoFlushIdleTime)
```
    参数:
    
    messageMaxLength - Maximum message length per pass (bytes)
    
    nettyReaderIdleTimeSeconds - Read idle interval (seconds)
    
    autoFlushIdleTime - Auto refresh buffer interval (s). If greater than 0, it will be on and auto refresh. If less than or equal to 0, it will refresh every time
- 方法详细资料
  - getProtocolName
```
public String getProtocolName()
```
    从接口复制的说明: ProtocolHandler
    
    Get the protocol name
    
    返回:
    
    name
  - canSupport
```
public boolean canSupport(io.netty.buffer.ByteBuf msg)
```
    从接口复制的说明: ProtocolHandler
    
    Support protocol
    
    参数:
    
    msg - client first message
    
    返回:
    
    true=Support, false=no Support
  - addPipeline
```
public void addPipeline(io.netty.channel.Channel channel)
                 throws Exception
```
    从接口复制的说明: ProtocolHandler
    
    add protocol pipeline support
    
    指定者:
    
    addPipeline 在接口中 ProtocolHandler
    
    覆盖:
    
    addPipeline 在类中 AbstractProtocol
    
    参数:
    
    channel - TCP channel
    
    抛出:
    
    Exception - Exception
  - getOrder
```
public int getOrder()
```
    从接口复制的说明: ProtocolHandler
    
    default Priority order 0
    
    指定者:
    
    getOrder 在接口中 Ordered
    
    指定者:
    
    getOrder 在接口中 ProtocolHandler
    
    指定者:
    
    getOrder 在接口中 ServerListener
    
    覆盖:
    
    getOrder 在类中 AbstractProtocol
    
    返回:
    
    The smaller the value of order, the more likely it is to be executed first
  - onServerStart
```
public <T extends AbstractNettyServer> void onServerStart(T server)
                                                   throws Exception
```
    抛出:
    
    Exception
  - onServerStop
```
public <T extends AbstractNettyServer> void onServerStop(T server)
                                                  throws Exception
```
    抛出:
    
    Exception
  - internalPublish
```
public void internalPublish(io.netty.handler.codec.mqtt.MqttPublishMessage msg,
                            String clientId)
```
  - addInterceptHandler
```
public void addInterceptHandler(InterceptHandler interceptHandler)
```
  - removeInterceptHandler
```
public void removeInterceptHandler(InterceptHandler interceptHandler)
```
  - isEnableMetrics
```
public boolean isEnableMetrics()
```
  - setEnableMetrics
```
public void setEnableMetrics(boolean enableMetrics)
```
  - getMetricsLibratoEmail
```
public String getMetricsLibratoEmail()
```
  - setMetricsLibratoEmail
```
public void setMetricsLibratoEmail(String metricsLibratoEmail)
```
  - getMetricsLibratoToken
```
public String getMetricsLibratoToken()
```
  - setMetricsLibratoToken
```
public void setMetricsLibratoToken(String metricsLibratoToken)
```
  - getMetricsLibratoSource
```
public String getMetricsLibratoSource()
```
  - setMetricsLibratoSource
```
public void setMetricsLibratoSource(String metricsLibratoSource)
```

类 MqttProtocol

字段概要

从接口继承的字段 com.github.netty.core.Ordered

构造器概要

方法概要

从类继承的方法 com.github.netty.core.AbstractProtocol

从类继承的方法 java.lang.Object

从接口继承的方法 com.github.netty.core.ProtocolHandler

从接口继承的方法 com.github.netty.core.ServerListener

从接口继承的方法 com.github.netty.core.Ordered

构造器详细资料

MqttProtocol

MqttProtocol

方法详细资料

getProtocolName

canSupport

addPipeline

getOrder

onServerStart

onServerStop

internalPublish

addInterceptHandler

removeInterceptHandler

isEnableMetrics

setEnableMetrics

getMetricsLibratoEmail

setMetricsLibratoEmail

getMetricsLibratoToken

setMetricsLibratoToken

getMetricsLibratoSource

setMetricsLibratoSource