DwmDns-0.1.0
DwmDnsRRDataSOA.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataSOA.hh 10129 $
3 // @(#) $Id: DwmDnsRRDataSOA.hh 10129 2018-01-27 04:20:26Z dwm $
4 //===========================================================================
5 // Copyright (c) Daniel W. McRobb 2000, 2016, 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 _DWMDNSRRDATASOA_HH_
43 #define _DWMDNSRRDATASOA_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 RRDataSOA
60  : public RRData
61  {
62  public:
63  static const uint16_t k_rrtype = 6;
64 
65  //----------------------------------------------------------------------
67  //----------------------------------------------------------------------
68  RRDataSOA();
69 
70  //----------------------------------------------------------------------
73  //----------------------------------------------------------------------
74  RRDataSOA(const std::string & mname, const std::string & rname,
75  uint32_t serial, uint32_t refresh, uint32_t retry,
76  uint32_t expire, uint32_t minimum);
77 
78  //----------------------------------------------------------------------
80  //----------------------------------------------------------------------
81  bool operator == (const RRDataSOA & soa) const;
82 
83  //----------------------------------------------------------------------
85  //----------------------------------------------------------------------
86  const std::string & Mname() const;
87 
88  //----------------------------------------------------------------------
90  //----------------------------------------------------------------------
91  const std::string & Mname(const std::string & mname);
92 
93  //----------------------------------------------------------------------
95  //----------------------------------------------------------------------
96  const std::string & Rname() const;
97 
98  //----------------------------------------------------------------------
100  //----------------------------------------------------------------------
101  const std::string & Rname(const std::string & rname);
102 
103  //----------------------------------------------------------------------
105  //----------------------------------------------------------------------
106  uint32_t Serial() const;
107 
108  //----------------------------------------------------------------------
110  //----------------------------------------------------------------------
111  uint32_t Serial(uint32_t serial);
112 
113  //----------------------------------------------------------------------
115  //----------------------------------------------------------------------
116  uint32_t Refresh() const;
117 
118  //----------------------------------------------------------------------
120  //----------------------------------------------------------------------
121  uint32_t Refresh(uint32_t refresh);
122 
123  //----------------------------------------------------------------------
125  //----------------------------------------------------------------------
126  uint32_t Retry() const;
127 
128  //----------------------------------------------------------------------
130  //----------------------------------------------------------------------
131  uint32_t Retry(uint32_t retry);
132 
133  //----------------------------------------------------------------------
135  //----------------------------------------------------------------------
136  uint32_t Expire() const;
137 
138  //----------------------------------------------------------------------
140  //----------------------------------------------------------------------
141  uint32_t Expire(uint32_t expire);
142 
143  //----------------------------------------------------------------------
145  //----------------------------------------------------------------------
146  uint32_t Minimum() const;
147 
148  //----------------------------------------------------------------------
150  //----------------------------------------------------------------------
151  uint32_t Minimum(uint32_t minimum);
152 
153  //----------------------------------------------------------------------
159  //----------------------------------------------------------------------
160  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
161  LabelPositions & lps) const;
162 
163  //----------------------------------------------------------------------
169  //----------------------------------------------------------------------
170  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
171  uint16_t pktlen, uint16_t rdlen);
172 
173  //----------------------------------------------------------------------
176  //----------------------------------------------------------------------
177  friend std::ostream & operator << (std::ostream & os,
178  const RRDataSOA & soa);
179 
180  private:
181  std::string _mname;
182  std::string _rname;
183  uint32_t _serial;
184  uint32_t _refresh;
185  uint32_t _retry;
186  uint32_t _expire;
187  uint32_t _minimum;
188  };
189 
190  } // namespace Dns
191 
192 } // namespace Dwm
193 
194 #endif // _DWMDNSRRDATANS_HH_
bool operator==(const RRDataSOA &soa) const
Equal-to operator, mostly for unit testing.
uint32_t Refresh() const
Returns the contained refresh.
uint32_t Expire() const
Returns the contained expire.
uint32_t Serial() const
Returns the contained serial.
uint32_t Minimum() const
Returns the contained minimum.
Definition: DwmDnsEtcHosts.hh:60
friend std::ostream & operator<<(std::ostream &os, const RRDataSOA &soa)
Print the SOA resource record data to an ostream in human readable form.
const uint8_t * Decode(const uint8_t *pkt, const uint8_t *ptr, uint16_t pktlen, uint16_t rdlen)
Decodes the SOA resource record data from buffer pkt of length pktlen, starting at ptr...
const std::string & Mname() const
Returns the contained MNAME.
uint32_t Retry() const
Returns the contained retry.
Dwm::Dns::RRData class definition.
Encapsulates SOA resource record data.
Definition: DwmDnsRRDataSOA.hh:59
RRDataSOA()
Construct with an empty MNAME and RNAME.
A helper class used when performing label sequence compression.
Definition: DwmDnsLabelPositions.hh:57
Abstract (pure virtual) base for resource record data classes.
Definition: DwmDnsRRData.hh:71
uint8_t * Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen, LabelPositions &lps) const
Encodes the SOA resource record data into buffer @ pkt of length pktlen, starting at ptr...
const std::string & Rname() const
Returns the contained RNAME.