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

https://bitbucket.org/freebsd/freebsd-head/ · C Header · 51 lines · 8 code · 9 blank · 34 comment · 0 complexity · 2dbb8734019f6fabee9e77bb4d98e6c7 MD5 · raw file

  1. /*
  2. * Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
  3. * Copyright (C) 2002 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: opcode.h,v 1.8 2007/06/19 23:47:17 tbox Exp $ */
  18. #ifndef DNS_OPCODE_H
  19. #define DNS_OPCODE_H 1
  20. /*! \file dns/opcode.h */
  21. #include <isc/lang.h>
  22. #include <dns/types.h>
  23. ISC_LANG_BEGINDECLS
  24. isc_result_t dns_opcode_totext(dns_opcode_t opcode, isc_buffer_t *target);
  25. /*%<
  26. * Put a textual representation of error 'opcode' into 'target'.
  27. *
  28. * Requires:
  29. *\li 'opcode' is a valid opcode.
  30. *
  31. *\li 'target' is a valid text buffer.
  32. *
  33. * Ensures:
  34. *\li If the result is success:
  35. * The used space in 'target' is updated.
  36. *
  37. * Returns:
  38. *\li #ISC_R_SUCCESS on success
  39. *\li #ISC_R_NOSPACE target buffer is too small
  40. */
  41. ISC_LANG_ENDDECLS
  42. #endif /* DNS_OPCODE_H */