View Javadoc
1   /*
2    * Copyright 2014 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  
17  package io.netty.handler.codec.mqtt;
18  
19  import io.netty.util.internal.ObjectUtil;
20  import io.netty.util.internal.StringUtil;
21  
22  /**
23   * See <a href="http://public.dhe.ibm.com/software/dw/webservices/ws-mqtt/mqtt-v3r1.html#fixed-header">
24   *     MQTTV3.1/fixed-header</a>
25   */
26  public final class MqttFixedHeader {
27  
28      private final MqttMessageType messageType;
29      private final boolean isDup;
30      private final MqttQoS qosLevel;
31      private final boolean isRetain;
32      private final int remainingLength;
33  
34      public MqttFixedHeader(
35              MqttMessageType messageType,
36              boolean isDup,
37              MqttQoS qosLevel,
38              boolean isRetain,
39              int remainingLength) {
40          this.messageType = ObjectUtil.checkNotNull(messageType, "messageType");
41          this.isDup = isDup;
42          this.qosLevel = ObjectUtil.checkNotNull(qosLevel, "qosLevel");
43          this.isRetain = isRetain;
44          this.remainingLength = remainingLength;
45      }
46  
47      public MqttMessageType messageType() {
48          return messageType;
49      }
50  
51      public boolean isDup() {
52          return isDup;
53      }
54  
55      public MqttQoS qosLevel() {
56          return qosLevel;
57      }
58  
59      public boolean isRetain() {
60          return isRetain;
61      }
62  
63      public int remainingLength() {
64          return remainingLength;
65      }
66  
67      @Override
68      public String toString() {
69          return new StringBuilder(StringUtil.simpleClassName(this))
70              .append('[')
71              .append("messageType=").append(messageType)
72              .append(", isDup=").append(isDup)
73              .append(", qosLevel=").append(qosLevel)
74              .append(", isRetain=").append(isRetain)
75              .append(", remainingLength=").append(remainingLength)
76              .append(']')
77              .toString();
78      }
79  }