Blame view

src/mqttutil.h 1.4 KB
51becbde   Peter M. Groen   Committed the ent...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
  #ifndef OSDEV_COMPONENTS_MQTT_MQTTUTIL_H
  #define OSDEV_COMPONENTS_MQTT_MQTTUTIL_H
  
  // std
  #include <string>
  
  namespace osdev {
  namespace components {
  namespace mqtt {
  
  /*!
   *  \brief  Determine if topic is a valid mqtt topic filter.
   *  \param  topic    - The topic to test.
   *  \return True when topic is valid, false otherwise.
   */
  bool isValidTopic( const std::string &topic );
  
  /*!
   *  \brief  Test a topic against another topicfilter for overlap.
   *  \param  existingTopic   - The topic to test against
   *  \param  newTopic        - The topic to test.
   *  \return True when topics overlap, false otherwise
   */
  bool testForOverlap( const std::string & existingTopic, const std::string &newTopic );
  
  /*!
   *  \brief  Test a topic for occurence of wildcards
   *  \param  topic   - The topic to test
   *  \return True if topics contains wildcards, false otherwise
   */
  bool hasWildcard( const std::string &topic );
  
  /*!
   *  \brief  Create a regular expression string based on a topicfilter that can be used
   *          to match topic strings against topics with no wildcards.
   *  \pre    The topic filter is valid.
   *  \return The regular expression string. If the topic filter is not valid then the
   *          returned string is also not valid.
   */
  std::string convertTopicToRegex( const std::string &topic );
  
  }       // End namespace mqtt
  }       // End namespace components
  }       // osdev
  
  #endif  // OSDEV_COMPONENTS_MQTT_MQTTUTIL_H