DwmDns-0.1.0
DwmDnsRRDataCAA.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataCAA.hh 10129 $
3 // @(#) $Id: DwmDnsRRDataCAA.hh 10129 2018-01-27 04:20:26Z dwm $
4 //===========================================================================
5 // Copyright (c) Daniel W. McRobb 2018
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
10 // are met:
11 //
12 // 1. Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // 2. Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // 3. The names of the authors and copyright holders may not be used to
18 // endorse or promote products derived from this software without
19 // specific prior written permission.
20 //
21 // IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
22 // DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
23 // INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
24 // EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
25 // DAMAGE.
26 //
27 // THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
28 // DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
29 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
30 // REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
31 // IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32 // WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
33 // OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
34 // TRADEMARK OR OTHER RIGHTS.
35 //===========================================================================
36 
37 //---------------------------------------------------------------------------
40 //---------------------------------------------------------------------------
41 
42 #ifndef _DWMDNSRRDATACAA_HH_
43 #define _DWMDNSRRDATACAA_HH_
44 
45 #include <cstdint>
46 #include <iostream>
47 #include <string>
48 
49 #include "DwmDnsRRData.hh"
50 
51 namespace Dwm {
52 
53  namespace Dns {
54 
55  //------------------------------------------------------------------------
58  //------------------------------------------------------------------------
59  class RRDataCAA
60  : public RRData
61  {
62  public:
63  static const uint16_t k_rrtype = 257;
64 
65  //----------------------------------------------------------------------
67  //----------------------------------------------------------------------
68  RRDataCAA();
69 
70  //----------------------------------------------------------------------
72  //----------------------------------------------------------------------
73  RRDataCAA(uint8_t flags, const std::string & tag,
74  const std::string & value);
75 
76  //----------------------------------------------------------------------
78  //----------------------------------------------------------------------
79  bool operator == (const RRDataCAA & caa) const;
80 
81  //----------------------------------------------------------------------
83  //----------------------------------------------------------------------
84  uint8_t Flags() const;
85 
86  //----------------------------------------------------------------------
88  //----------------------------------------------------------------------
89  uint8_t Flags(uint8_t flags);
90 
91  //----------------------------------------------------------------------
93  //----------------------------------------------------------------------
94  const std::string & Tag() const;
95 
96  //----------------------------------------------------------------------
98  //----------------------------------------------------------------------
99  const std::string & Tag(const std::string & tag);
100 
101  //----------------------------------------------------------------------
103  //----------------------------------------------------------------------
104  const std::string & Value() const;
105 
106  //----------------------------------------------------------------------
108  //----------------------------------------------------------------------
109  const std::string & Value(const std::string & value);
110 
111  //----------------------------------------------------------------------
117  //----------------------------------------------------------------------
118  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
119  LabelPositions & lps) const;
120 
121  //----------------------------------------------------------------------
127  //----------------------------------------------------------------------
128  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
129  uint16_t pktlen, uint16_t rdlen);
130 
131  //----------------------------------------------------------------------
134  //----------------------------------------------------------------------
135  friend std::ostream & operator << (std::ostream & os,
136  const RRDataCAA & caa);
137 
138  private:
139  uint8_t _flags;
140  std::string _tag;
141  std::string _value;
142  };
143 
144  } // namespace Dns
145 
146 } // namespace Dwm
147 
148 #endif // _DWMDNSRRDATACAA_HH_
const uint8_t * Decode(const uint8_t *pkt, const uint8_t *ptr, uint16_t pktlen, uint16_t rdlen)
Decodes the CAA resource record data from buffer pkt of length pktlen, starting at ptr...
const std::string & Tag() const
Returns the tag in the CAA resource record data.
friend std::ostream & operator<<(std::ostream &os, const RRDataCAA &caa)
Print the CAA resource record data to an ostream in human readable form.
RRDataCAA()
Default constructor.
uint8_t Flags() const
Returns the flags in the CAA resource record data.
Encapsulates CAA resource record data.
Definition: DwmDnsRRDataCAA.hh:59
Definition: DwmDnsEtcHosts.hh:60
Dwm::Dns::RRData class definition.
const std::string & Value() const
Returns the value in the CAA resource record data.
A helper class used when performing label sequence compression.
Definition: DwmDnsLabelPositions.hh:57
uint8_t * Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen, LabelPositions &lps) const
Encodes the CAA resource record data into buffer @ pkt of length pktlen, starting at ptr...
bool operator==(const RRDataCAA &caa) const
Equal-to operator, mostly for unit testing.
Abstract (pure virtual) base for resource record data classes.
Definition: DwmDnsRRData.hh:71