/contrib/bind9/lib/dns/include/dns/rdataclass.h

https://bitbucket.org/freebsd/freebsd-head/ · C Header · 81 lines · 15 code · 12 blank · 54 comment · 0 complexity · cd6828c58f42d9480f13b56f51cbb172 MD5 · raw file

  1. /*
  2. * Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
  3. * Copyright (C) 1998-2001 Internet Software Consortium.
  4. *
  5. * Permission to use, copy, modify, and/or distribute this software for any
  6. * purpose with or without fee is hereby granted, provided that the above
  7. * copyright notice and this permission notice appear in all copies.
  8. *
  9. * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10. * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11. * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12. * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13. * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14. * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15. * PERFORMANCE OF THIS SOFTWARE.
  16. */
  17. /* $Id: rdataclass.h,v 1.24 2007/06/19 23:47:17 tbox Exp $ */
  18. #ifndef DNS_RDATACLASS_H
  19. #define DNS_RDATACLASS_H 1
  20. /*! \file dns/rdataclass.h */
  21. #include <isc/lang.h>
  22. #include <dns/types.h>
  23. ISC_LANG_BEGINDECLS
  24. isc_result_t
  25. dns_rdataclass_fromtext(dns_rdataclass_t *classp, isc_textregion_t *source);
  26. /*%<
  27. * Convert the text 'source' refers to into a DNS class.
  28. *
  29. * Requires:
  30. *\li 'classp' is a valid pointer.
  31. *
  32. *\li 'source' is a valid text region.
  33. *
  34. * Returns:
  35. *\li #ISC_R_SUCCESS on success
  36. *\li #DNS_R_UNKNOWN class is unknown
  37. */
  38. isc_result_t
  39. dns_rdataclass_totext(dns_rdataclass_t rdclass, isc_buffer_t *target);
  40. /*%<
  41. * Put a textual representation of class 'rdclass' into 'target'.
  42. *
  43. * Requires:
  44. *\li 'rdclass' is a valid class.
  45. *
  46. *\li 'target' is a valid text buffer.
  47. *
  48. * Ensures,
  49. * if the result is success:
  50. *\li The used space in 'target' is updated.
  51. *
  52. * Returns:
  53. *\li #ISC_R_SUCCESS on success
  54. *\li #ISC_R_NOSPACE target buffer is too small
  55. */
  56. void
  57. dns_rdataclass_format(dns_rdataclass_t rdclass,
  58. char *array, unsigned int size);
  59. /*%<
  60. * Format a human-readable representation of the class 'rdclass'
  61. * into the character array 'array', which is of size 'size'.
  62. * The resulting string is guaranteed to be null-terminated.
  63. */
  64. #define DNS_RDATACLASS_FORMATSIZE sizeof("CLASS65535")
  65. /*%<
  66. * Minimum size of array to pass to dns_rdataclass_format().
  67. */
  68. ISC_LANG_ENDDECLS
  69. #endif /* DNS_RDATACLASS_H */