Blame view

include/mqttidgenerator.h 2.85 KB
b5d9e433   Peter M. Groen   Fixed License Hea...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  /* ****************************************************************************
   * Copyright 2019 Open Systems Development BV                                 *
   *                                                                            *
   * Permission is hereby granted, free of charge, to any person obtaining a    *
   * copy of this software and associated documentation files (the "Software"), *
   * to deal in the Software without restriction, including without limitation  *
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
   * and/or sell copies of the Software, and to permit persons to whom the      *
   * Software is furnished to do so, subject to the following conditions:       *
   *                                                                            *
   * The above copyright notice and this permission notice shall be included in *
   * all copies or substantial portions of the Software.                        *
   *                                                                            *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
   * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
   * DEALINGS IN THE SOFTWARE.                                                  *
   * ***************************************************************************/
51becbde   Peter M. Groen   Committed the ent...
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
  #ifndef OSDEV_COMPONENTS_MQTT_MLOGICIDGENERATOR_H
  #define OSDEV_COMPONENTS_MQTT_MLOGICIDGENERATOR_H
  
  // std
  #include <string>
  
  // osdev::components::mqtt
  #include "commondefs.h"
  
  namespace osdev {
  namespace components {
  namespace mqtt {
  
  class MqttIdGenerator
  {
  public:
      /**
       * @brief Generates a new MqttId, which is guaranteed to be unique.
       * @return A new unique MqttId.
       */
      static MqttId generate();
  
      /**
       * @brief Returns an MqttId that represents null.
       * @return An MqttId that represents null.
       */
      static MqttId nullId();
  
      /**
        * @brief Returns an MqttId based on a namespace uuid and a given string.
        * @param namespaceUuid The namespace in which the MqttId is generated.
        * @param name The name for which an MqttId is generated.
        */
      static MqttId nameId(MqttId namespaceUuid, const std::string& name);
  
      /**
        * @brief Returns an MqttId in the MQTT namespace for a given string.
        * @param name The name for which an MqttId is generated.
        */
      static MqttId nameId(const std::string& name);
  };
  
  }       // End namespace mqtt
  }       // End namespace components
  }       // End namespace osdev
  
  #endif  // OSDEV_COMPONENTS_MQTT_MLOGICIDGENERATOR_H