Kea  1.5.0
rrtype.h
Go to the documentation of this file.
1 
8 // Copyright (C) 2010-2015 Internet Systems Consortium, Inc. ("ISC")
9 //
10 // This Source Code Form is subject to the terms of the Mozilla Public
11 // License, v. 2.0. If a copy of the MPL was not distributed with this
12 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
13 
14 #ifndef RRTYPE_H
15 #define RRTYPE_H 1
16 
17 #include <stdint.h>
18 
19 #include <string>
20 #include <ostream>
21 
22 #include <dns/exceptions.h>
23 
24 // Solaris x86 defines DS in <sys/regset.h>, which gets pulled in by Boost
25 #if defined(__sun) && defined(DS)
26 # undef DS
27 #endif
28 
29 namespace isc {
30 namespace util {
31 class InputBuffer;
32 class OutputBuffer;
33 }
34 
35 namespace dns {
36 
37 // forward declarations
38 class AbstractMessageRenderer;
39 
44 class InvalidRRType : public DNSTextError {
45 public:
46  InvalidRRType(const char* file, size_t line, const char* what) :
47  DNSTextError(file, line, what) {}
48 };
49 
54 class IncompleteRRType : public isc::dns::Exception {
55 public:
56  IncompleteRRType(const char* file, size_t line, const char* what) :
57  isc::dns::Exception(file, line, what) {}
58 };
59 
106 class RRType {
107 public:
111 
112  explicit RRType(uint16_t typecode) : typecode_(typecode) {}
144  explicit RRType(const std::string& typestr);
155  explicit RRType(isc::util::InputBuffer& buffer);
158 
159 
165 
166  const std::string toText() const;
189  void toWire(AbstractMessageRenderer& renderer) const;
199  void toWire(isc::util::OutputBuffer& buffer) const;
201 
205 
206  uint16_t getCode() const { return (typecode_); }
213 
217 
218  bool equals(const RRType& other) const
227  { return (typecode_ == other.typecode_); }
229  bool operator==(const RRType& other) const { return (equals(other)); }
230 
237  bool nequals(const RRType& other) const
238  { return (typecode_ != other.typecode_); }
240  bool operator!=(const RRType& other) const { return (nequals(other)); }
241 
257  bool operator<(const RRType& other) const
258  { return (typecode_ < other.typecode_); }
260 
261  // BEGIN_WELL_KNOWN_TYPE_DECLARATIONS
262  static const RRType& L32();
263  static const RRType& NID();
264  static const RRType& LP();
265  static const RRType& L64();
266  static const RRType& UNSPEC();
267  static const RRType& IXFR();
268  static const RRType& TSIG();
269  static const RRType& MAILB();
270  static const RRType& AXFR();
271  static const RRType& ANY();
272  static const RRType& MAILA();
273  static const RRType& CAA();
274  static const RRType& URI();
275  static const RRType& KEY();
276  static const RRType& SIG();
277  static const RRType& GPOS();
278  static const RRType& PX();
279  static const RRType& RT();
280  static const RRType& ISDN();
281  static const RRType& NSAP_PTR();
282  static const RRType& NSAP();
283  static const RRType& LOC();
284  static const RRType& AAAA();
285  static const RRType& SPF();
286  static const RRType& MG();
287  static const RRType& SOA();
288  static const RRType& MF();
289  static const RRType& NS();
290  static const RRType& NSEC3();
291  static const RRType& NSEC3PARAM();
292  static const RRType& TLSA();
293  static const RRType& AFSDB();
294  static const RRType& HIP();
295  static const RRType& MINFO();
296  static const RRType& MX();
297  static const RRType& TXT();
298  static const RRType& RP();
299  static const RRType& Null();
300  static const RRType& WKS();
301  static const RRType& PTR();
302  static const RRType& HINFO();
303  static const RRType& DLV();
304  static const RRType& DS();
305  static const RRType& APL();
306  static const RRType& OPT();
307  static const RRType& NSEC();
308  static const RRType& RRSIG();
309  static const RRType& IPSECKEY();
310  static const RRType& SSHFP();
311  static const RRType& DHCID();
312  static const RRType& DNSKEY();
313  static const RRType& X25();
314  static const RRType& TKEY();
315  static const RRType& MR();
316  static const RRType& MB();
317  static const RRType& CNAME();
318  static const RRType& MD();
319  static const RRType& A();
320  static const RRType& A6();
321  static const RRType& DNAME();
322  static const RRType& SRV();
323  static const RRType& NXT();
324  static const RRType& KX();
325  static const RRType& CERT();
326  static const RRType& NAPTR();
327  // END_WELL_KNOWN_TYPE_DECLARATIONS
328 
329 private:
330  uint16_t typecode_;
331 };
332 
333 // BEGIN_WELL_KNOWN_TYPE_DEFINITIONS
334 inline const RRType&
335 RRType::L32() {
336  static RRType rrtype(105);
337  return (rrtype);
338 }
339 
340 inline const RRType&
341 RRType::NID() {
342  static RRType rrtype(104);
343  return (rrtype);
344 }
345 
346 inline const RRType&
347 RRType::LP() {
348  static RRType rrtype(107);
349  return (rrtype);
350 }
351 
352 inline const RRType&
353 RRType::L64() {
354  static RRType rrtype(106);
355  return (rrtype);
356 }
357 
358 inline const RRType&
359 RRType::UNSPEC() {
360  static RRType rrtype(103);
361  return (rrtype);
362 }
363 
364 inline const RRType&
365 RRType::IXFR() {
366  static RRType rrtype(251);
367  return (rrtype);
368 }
369 
370 inline const RRType&
371 RRType::TSIG() {
372  static RRType rrtype(250);
373  return (rrtype);
374 }
375 
376 inline const RRType&
377 RRType::MAILB() {
378  static RRType rrtype(253);
379  return (rrtype);
380 }
381 
382 inline const RRType&
383 RRType::AXFR() {
384  static RRType rrtype(252);
385  return (rrtype);
386 }
387 
388 inline const RRType&
389 RRType::ANY() {
390  static RRType rrtype(255);
391  return (rrtype);
392 }
393 
394 inline const RRType&
395 RRType::MAILA() {
396  static RRType rrtype(254);
397  return (rrtype);
398 }
399 
400 inline const RRType&
401 RRType::CAA() {
402  static RRType rrtype(257);
403  return (rrtype);
404 }
405 
406 inline const RRType&
407 RRType::URI() {
408  static RRType rrtype(256);
409  return (rrtype);
410 }
411 
412 inline const RRType&
413 RRType::KEY() {
414  static RRType rrtype(25);
415  return (rrtype);
416 }
417 
418 inline const RRType&
419 RRType::SIG() {
420  static RRType rrtype(24);
421  return (rrtype);
422 }
423 
424 inline const RRType&
425 RRType::GPOS() {
426  static RRType rrtype(27);
427  return (rrtype);
428 }
429 
430 inline const RRType&
431 RRType::PX() {
432  static RRType rrtype(26);
433  return (rrtype);
434 }
435 
436 inline const RRType&
437 RRType::RT() {
438  static RRType rrtype(21);
439  return (rrtype);
440 }
441 
442 inline const RRType&
443 RRType::ISDN() {
444  static RRType rrtype(20);
445  return (rrtype);
446 }
447 
448 inline const RRType&
449 RRType::NSAP_PTR() {
450  static RRType rrtype(23);
451  return (rrtype);
452 }
453 
454 inline const RRType&
455 RRType::NSAP() {
456  static RRType rrtype(22);
457  return (rrtype);
458 }
459 
460 inline const RRType&
461 RRType::LOC() {
462  static RRType rrtype(29);
463  return (rrtype);
464 }
465 
466 inline const RRType&
467 RRType::AAAA() {
468  static RRType rrtype(28);
469  return (rrtype);
470 }
471 
472 inline const RRType&
473 RRType::SPF() {
474  static RRType rrtype(99);
475  return (rrtype);
476 }
477 
478 inline const RRType&
479 RRType::MG() {
480  static RRType rrtype(8);
481  return (rrtype);
482 }
483 
484 inline const RRType&
485 RRType::SOA() {
486  static RRType rrtype(6);
487  return (rrtype);
488 }
489 
490 inline const RRType&
491 RRType::MF() {
492  static RRType rrtype(4);
493  return (rrtype);
494 }
495 
496 inline const RRType&
497 RRType::NS() {
498  static RRType rrtype(2);
499  return (rrtype);
500 }
501 
502 inline const RRType&
503 RRType::NSEC3() {
504  static RRType rrtype(50);
505  return (rrtype);
506 }
507 
508 inline const RRType&
509 RRType::NSEC3PARAM() {
510  static RRType rrtype(51);
511  return (rrtype);
512 }
513 
514 inline const RRType&
515 RRType::TLSA() {
516  static RRType rrtype(52);
517  return (rrtype);
518 }
519 
520 inline const RRType&
521 RRType::AFSDB() {
522  static RRType rrtype(18);
523  return (rrtype);
524 }
525 
526 inline const RRType&
527 RRType::HIP() {
528  static RRType rrtype(55);
529  return (rrtype);
530 }
531 
532 inline const RRType&
533 RRType::MINFO() {
534  static RRType rrtype(14);
535  return (rrtype);
536 }
537 
538 inline const RRType&
539 RRType::MX() {
540  static RRType rrtype(15);
541  return (rrtype);
542 }
543 
544 inline const RRType&
545 RRType::TXT() {
546  static RRType rrtype(16);
547  return (rrtype);
548 }
549 
550 inline const RRType&
551 RRType::RP() {
552  static RRType rrtype(17);
553  return (rrtype);
554 }
555 
556 inline const RRType&
557 RRType::Null() {
558  static RRType rrtype(10);
559  return (rrtype);
560 }
561 
562 inline const RRType&
563 RRType::WKS() {
564  static RRType rrtype(11);
565  return (rrtype);
566 }
567 
568 inline const RRType&
569 RRType::PTR() {
570  static RRType rrtype(12);
571  return (rrtype);
572 }
573 
574 inline const RRType&
575 RRType::HINFO() {
576  static RRType rrtype(13);
577  return (rrtype);
578 }
579 
580 inline const RRType&
581 RRType::DLV() {
582  static RRType rrtype(32769);
583  return (rrtype);
584 }
585 
586 inline const RRType&
587 RRType::DS() {
588  static RRType rrtype(43);
589  return (rrtype);
590 }
591 
592 inline const RRType&
593 RRType::APL() {
594  static RRType rrtype(42);
595  return (rrtype);
596 }
597 
598 inline const RRType&
599 RRType::OPT() {
600  static RRType rrtype(41);
601  return (rrtype);
602 }
603 
604 inline const RRType&
605 RRType::NSEC() {
606  static RRType rrtype(47);
607  return (rrtype);
608 }
609 
610 inline const RRType&
611 RRType::RRSIG() {
612  static RRType rrtype(46);
613  return (rrtype);
614 }
615 
616 inline const RRType&
617 RRType::IPSECKEY() {
618  static RRType rrtype(45);
619  return (rrtype);
620 }
621 
622 inline const RRType&
623 RRType::SSHFP() {
624  static RRType rrtype(44);
625  return (rrtype);
626 }
627 
628 inline const RRType&
629 RRType::DHCID() {
630  static RRType rrtype(49);
631  return (rrtype);
632 }
633 
634 inline const RRType&
635 RRType::DNSKEY() {
636  static RRType rrtype(48);
637  return (rrtype);
638 }
639 
640 inline const RRType&
641 RRType::X25() {
642  static RRType rrtype(19);
643  return (rrtype);
644 }
645 
646 inline const RRType&
647 RRType::TKEY() {
648  static RRType rrtype(249);
649  return (rrtype);
650 }
651 
652 inline const RRType&
653 RRType::MR() {
654  static RRType rrtype(9);
655  return (rrtype);
656 }
657 
658 inline const RRType&
659 RRType::MB() {
660  static RRType rrtype(7);
661  return (rrtype);
662 }
663 
664 inline const RRType&
665 RRType::CNAME() {
666  static RRType rrtype(5);
667  return (rrtype);
668 }
669 
670 inline const RRType&
671 RRType::MD() {
672  static RRType rrtype(3);
673  return (rrtype);
674 }
675 
676 inline const RRType&
677 RRType::A() {
678  static RRType rrtype(1);
679  return (rrtype);
680 }
681 
682 inline const RRType&
683 RRType::A6() {
684  static RRType rrtype(38);
685  return (rrtype);
686 }
687 
688 inline const RRType&
689 RRType::DNAME() {
690  static RRType rrtype(39);
691  return (rrtype);
692 }
693 
694 inline const RRType&
695 RRType::SRV() {
696  static RRType rrtype(33);
697  return (rrtype);
698 }
699 
700 inline const RRType&
701 RRType::NXT() {
702  static RRType rrtype(30);
703  return (rrtype);
704 }
705 
706 inline const RRType&
707 RRType::KX() {
708  static RRType rrtype(36);
709  return (rrtype);
710 }
711 
712 inline const RRType&
713 RRType::CERT() {
714  static RRType rrtype(37);
715  return (rrtype);
716 }
717 
718 inline const RRType&
719 RRType::NAPTR() {
720  static RRType rrtype(35);
721  return (rrtype);
722 }
723 
724 // END_WELL_KNOWN_TYPE_DEFINITIONS
725 
740 std::ostream&
741 operator<<(std::ostream& os, const RRType& rrtype);
742 }
743 }
744 #endif // RRTYPE_H
745 
746 // Local Variables:
747 // mode: c++
748 // End:
isc::dns::RRType::NXT
static const RRType & NXT()
Definition: rrtype.h:701
isc::dns::RRType::TKEY
static const RRType & TKEY()
Definition: rrtype.h:647
isc::dns::RRType::MF
static const RRType & MF()
Definition: rrtype.h:491
isc::dns::RRType::A6
static const RRType & A6()
Definition: rrtype.h:683
isc::dns::RRType::GPOS
static const RRType & GPOS()
Definition: rrtype.h:425
isc::dns::RRType::WKS
static const RRType & WKS()
Definition: rrtype.h:563
isc::dns::RRType::RRType
RRType(uint16_t typecode)
Constructor from an integer type code.
Definition: rrtype.h:117
isc::dns::RRType::NSAP_PTR
static const RRType & NSAP_PTR()
Definition: rrtype.h:449
isc::dns::RRType::CERT
static const RRType & CERT()
Definition: rrtype.h:713
isc::dns::RRType::A
static const RRType & A()
Definition: rrtype.h:677
isc::dns::RRType::NSEC3PARAM
static const RRType & NSEC3PARAM()
Definition: rrtype.h:509
isc::dns::RRType::SSHFP
static const RRType & SSHFP()
Definition: rrtype.h:623
isc::dns::RRType::X25
static const RRType & X25()
Definition: rrtype.h:641
isc::dns::RRType::operator==
bool operator==(const RRType &other) const
Same as equals().
Definition: rrtype.h:229
isc::dns::RRType::SIG
static const RRType & SIG()
Definition: rrtype.h:419
isc::dns::RRType::HIP
static const RRType & HIP()
Definition: rrtype.h:527
isc::dns::RRType::MB
static const RRType & MB()
Definition: rrtype.h:659
isc::dns::RRType::HINFO
static const RRType & HINFO()
Definition: rrtype.h:575
isc::dns::RRType::RRSIG
static const RRType & RRSIG()
Definition: rrtype.h:611
isc::dns::RRType::UNSPEC
static const RRType & UNSPEC()
Definition: rrtype.h:359
isc::dns::RRType::SPF
static const RRType & SPF()
Definition: rrtype.h:473
isc::dns::RRType::toText
const std::string toText() const
Convert the RRType to a string.
Definition: rrtype.cc:45
isc::dns::RRType::KEY
static const RRType & KEY()
Definition: rrtype.h:413
isc::dns::RRType::MINFO
static const RRType & MINFO()
Definition: rrtype.h:533
isc::dns::RRType::getCode
uint16_t getCode() const
Returns the RR type code as a 16-bit unsigned integer.
Definition: rrtype.h:211
isc::dns::RRType::Null
static const RRType & Null()
Definition: rrtype.h:557
isc::dns::RRType::LP
static const RRType & LP()
Definition: rrtype.h:347
isc::dns::RRType::MX
static const RRType & MX()
Definition: rrtype.h:539
isc::dns::IncompleteRRType
A standard DNS module exception that is thrown if an RRType object is being constructed from a incomp...
Definition: rrtype.h:54
isc::dns::RRType::nequals
bool nequals(const RRType &other) const
Return true iff two RRTypes are not equal.
Definition: rrtype.h:237
isc::dns::RRType::PTR
static const RRType & PTR()
Definition: rrtype.h:569
isc::dns::RRType::CAA
static const RRType & CAA()
Definition: rrtype.h:401
isc::dns::RRType::MAILB
static const RRType & MAILB()
Definition: rrtype.h:377
isc::dns::RRType::NSAP
static const RRType & NSAP()
Definition: rrtype.h:455
isc::dns::RRType::TXT
static const RRType & TXT()
Definition: rrtype.h:545
exceptions.h
isc::dns::RRType::MR
static const RRType & MR()
Definition: rrtype.h:653
isc::dns::RRType::operator<
bool operator<(const RRType &other) const
Less-than comparison for RRType against other.
Definition: rrtype.h:257
isc::dns::AbstractMessageRenderer
The AbstractMessageRenderer class is an abstract base class that provides common interfaces for rende...
Definition: messagerenderer.h:68
isc::dns::RRType::IPSECKEY
static const RRType & IPSECKEY()
Definition: rrtype.h:617
isc
Defines the logger used by the top-level component of kea-dhcp-ddns.
Definition: agent_parser.cc:144
isc::Exception::what
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
Definition: exceptions/exceptions.cc:32
isc::dns::RRType::PX
static const RRType & PX()
Definition: rrtype.h:431
isc::dns::InvalidRRType
A standard DNS module exception that is thrown if an RRType object is being constructed from an unrec...
Definition: rrtype.h:44
isc::dns::operator<<
ostream & operator<<(std::ostream &os, const EDNS &edns)
Insert the EDNS as a string into stream.
Definition: edns.cc:172
isc::dns::RRType::NSEC3
static const RRType & NSEC3()
Definition: rrtype.h:503
isc::dns::RRType::NSEC
static const RRType & NSEC()
Definition: rrtype.h:605
isc::dns::RRType::RT
static const RRType & RT()
Definition: rrtype.h:437
isc::dns::RRType::operator!=
bool operator!=(const RRType &other) const
Same as nequals().
Definition: rrtype.h:240
isc::dns::RRType::DNAME
static const RRType & DNAME()
Definition: rrtype.h:689
isc::dns::RRType::TSIG
static const RRType & TSIG()
Definition: rrtype.h:371
isc::util::OutputBuffer
The OutputBuffer class is a buffer abstraction for manipulating mutable data.
Definition: buffer.h:294
isc::dns::Exception
Definition: dns/exceptions.h:25
isc::dns::RRType::OPT
static const RRType & OPT()
Definition: rrtype.h:599
isc::dns::RRType::equals
bool equals(const RRType &other) const
Return true iff two RRTypes are equal.
Definition: rrtype.h:226
isc::dns::RRType::DHCID
static const RRType & DHCID()
Definition: rrtype.h:629
isc::dns::DNSTextError
Base class for all sorts of text parse errors.
Definition: dns/exceptions.h:34
isc::dns::RRType::AFSDB
static const RRType & AFSDB()
Definition: rrtype.h:521
isc::dns::RRType::L32
static const RRType & L32()
Definition: rrtype.h:335
isc::dns::RRType::KX
static const RRType & KX()
Definition: rrtype.h:707
isc::dns::RRType::ANY
static const RRType & ANY()
Definition: rrtype.h:389
isc::dns::RRType::DS
static const RRType & DS()
Definition: rrtype.h:587
isc::dns::RRType::RP
static const RRType & RP()
Definition: rrtype.h:551
isc::dns::RRType::SRV
static const RRType & SRV()
Definition: rrtype.h:695
isc::util::InputBuffer
The InputBuffer class is a buffer abstraction for manipulating read-only data.
Definition: buffer.h:81
isc::dns::RRType::toWire
void toWire(AbstractMessageRenderer &renderer) const
Render the RRType in the wire format.
Definition: rrtype.cc:55
isc::dns::RRType::NAPTR
static const RRType & NAPTR()
Definition: rrtype.h:719
isc::dns::RRType::L64
static const RRType & L64()
Definition: rrtype.h:353
isc::dns::InvalidRRType::InvalidRRType
InvalidRRType(const char *file, size_t line, const char *what)
Definition: rrtype.h:46
isc::dns::RRType::MD
static const RRType & MD()
Definition: rrtype.h:671
isc::dns::RRType::ISDN
static const RRType & ISDN()
Definition: rrtype.h:443
isc::dns::RRType::APL
static const RRType & APL()
Definition: rrtype.h:593
isc::dns::RRType::MAILA
static const RRType & MAILA()
Definition: rrtype.h:395
isc::dns::RRType::MG
static const RRType & MG()
Definition: rrtype.h:479
isc::dns::RRType::TLSA
static const RRType & TLSA()
Definition: rrtype.h:515
isc::dns::RRType::DNSKEY
static const RRType & DNSKEY()
Definition: rrtype.h:635
isc::dns::RRType::NID
static const RRType & NID()
Definition: rrtype.h:341
isc::dns::RRType
The RRType class encapsulates DNS resource record types.
Definition: rrtype.h:106
isc::dns::RRType::NS
static const RRType & NS()
Definition: rrtype.h:497
isc::dns::RRType::AAAA
static const RRType & AAAA()
Definition: rrtype.h:467
isc::dns::RRType::LOC
static const RRType & LOC()
Definition: rrtype.h:461
isc::dns::RRType::CNAME
static const RRType & CNAME()
Definition: rrtype.h:665
isc::dns::IncompleteRRType::IncompleteRRType
IncompleteRRType(const char *file, size_t line, const char *what)
Definition: rrtype.h:56
isc::dns::RRType::IXFR
static const RRType & IXFR()
Definition: rrtype.h:365
isc::dns::RRType::URI
static const RRType & URI()
Definition: rrtype.h:407
isc::dns::RRType::DLV
static const RRType & DLV()
Definition: rrtype.h:581
isc::dns::RRType::SOA
static const RRType & SOA()
Definition: rrtype.h:485
isc::dns::RRType::AXFR
static const RRType & AXFR()
Definition: rrtype.h:383