DwmDns-0.1.0
DwmDnsRRDataTXT.hh
Go to the documentation of this file.
1 //===========================================================================
2 // @(#) $DwmPath: dwm/DwmDns/tags/DwmDns-0.1.0/classes/include/DwmDnsRRDataTXT.hh 10129 $
3 // @(#) $Id: DwmDnsRRDataTXT.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 _DWMDNSRRDATATXT_HH_
43 #define _DWMDNSRRDATATXT_HH_
44 
45 #include <cstdint>
46 #include <iostream>
47 #include <string>
48 #include <vector>
49 
50 #include "DwmDnsRRData.hh"
51 
52 namespace Dwm {
53 
54  namespace Dns {
55 
56  //------------------------------------------------------------------------
59  //------------------------------------------------------------------------
60  class RRDataTXT
61  : public RRData
62  {
63  public:
64  static const uint16_t k_rrtype = 16;
65 
66  //----------------------------------------------------------------------
68  //----------------------------------------------------------------------
69  RRDataTXT();
70 
71  //----------------------------------------------------------------------
73  //----------------------------------------------------------------------
74  RRDataTXT(const std::vector<std::string> & txt);
75 
76  //----------------------------------------------------------------------
78  //----------------------------------------------------------------------
79  bool operator == (const RRDataTXT & txt) const;
80 
81  //----------------------------------------------------------------------
83  //----------------------------------------------------------------------
84  const std::vector<std::string> & Txt() const;
85 
86  //----------------------------------------------------------------------
88  //----------------------------------------------------------------------
89  const std::vector<std::string> &
90  Txt(const std::vector<std::string> & txt);
91 
92  //----------------------------------------------------------------------
98  //----------------------------------------------------------------------
99  uint8_t *Encode(uint8_t *pkt, uint8_t *ptr, uint16_t pktlen,
100  LabelPositions & lps) const;
101 
102  //----------------------------------------------------------------------
108  //----------------------------------------------------------------------
109  const uint8_t *Decode(const uint8_t *pkt, const uint8_t *ptr,
110  uint16_t pktlen, uint16_t rdlen);
111 
112  //----------------------------------------------------------------------
115  //----------------------------------------------------------------------
116  friend std::ostream & operator << (std::ostream & os,
117  const RRDataTXT & txt);
118 
119  private:
120  std::vector<std::string> _txt;
121  };
122 
123  } // namespace Dns
124 
125 } // namespace Dwm
126 
127 #endif // _DWMDNSRRDATATXT_HH_
bool operator==(const RRDataTXT &txt) const
Equal-to operator, mostly for unit testing.
RRDataTXT()
Construct with empty data.
const std::vector< std::string > & Txt() const
Returns the contained TXT data.
Definition: DwmDnsEtcHosts.hh:60
Dwm::Dns::RRData class definition.
const uint8_t * Decode(const uint8_t *pkt, const uint8_t *ptr, uint16_t pktlen, uint16_t rdlen)
Decodes the TXT resource record data from buffer pkt of length pktlen, starting at ptr...
A helper class used when performing label sequence compression.
Definition: DwmDnsLabelPositions.hh:57
friend std::ostream & operator<<(std::ostream &os, const RRDataTXT &txt)
Print the TXT resource record data to an ostream in human readable form.
Encapsulates TXT resource record data.
Definition: DwmDnsRRDataTXT.hh:60
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 TXT resource record data into buffer @ pkt of length pktlen, starting at ptr...