DwmDns-0.1.0
DwmDnsRRDataDomainName.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataDomainName.hh 10130 $
3 // @(#) $Id: DwmDnsRRDataDomainName.hh 10130 2018-01-27 04:36:23Z 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 _DWMDNSRRDATADOMAINNAME_HH_
43 #define _DWMDNSRRDATADOMAINNAME_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  //------------------------------------------------------------------------
59  //------------------------------------------------------------------------
61  : public RRData
62  {
63  public:
64  //----------------------------------------------------------------------
66  //----------------------------------------------------------------------
68 
69  //----------------------------------------------------------------------
71  //----------------------------------------------------------------------
72  RRDataDomainName(const std::string & value);
73 
74  //----------------------------------------------------------------------
76  //----------------------------------------------------------------------
77  bool operator == (const RRDataDomainName & domainName) const;
78 
79  //----------------------------------------------------------------------
81  //----------------------------------------------------------------------
82  const std::string & Value() const;
83 
84  //----------------------------------------------------------------------
86  //----------------------------------------------------------------------
87  const std::string & Value(const std::string & value);
88 
89  //----------------------------------------------------------------------
96  //----------------------------------------------------------------------
97  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
98  LabelPositions & lps) const;
99 
100  //----------------------------------------------------------------------
106  //----------------------------------------------------------------------
107  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
108  uint16_t pktlen, uint16_t rdlen);
109 
110  //----------------------------------------------------------------------
113  //----------------------------------------------------------------------
114  friend std::ostream & operator << (std::ostream & os,
115  const RRDataDomainName & domainName);
116 
117  protected:
118  std::string _value;
119  };
120 
121  } // namespace Dns
122 
123 } // namespace Dwm
124 
125 #endif // _DWMDNSRRDATADOMAINNAME_HH_
const std::string & Value() const
Returns the contained domain name.
Encapsulates data for any resource recourd which only contains a domain name.
Definition: DwmDnsRRDataDomainName.hh:60
uint8_t * Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen, LabelPositions &lps) const
Encodes the domain name resource record data into buffer @ pkt of length pktlen, starting at ptr...
friend std::ostream & operator<<(std::ostream &os, const RRDataDomainName &domainName)
Print the domain name 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 domain name resource record data from buffer pkt of length pktlen, starting at ptr...
RRDataDomainName()
constructs an empty domain name resource record data object.
Definition: DwmDnsEtcHosts.hh:60
Dwm::Dns::RRData class definition.
bool operator==(const RRDataDomainName &domainName) const
Equal-to operator, mostly for unit testing.
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