/contrib/bind9/lib/dns/include/dns/secproto.h
https://bitbucket.org/freebsd/freebsd-head/ · C Header · 71 lines · 11 code · 10 blank · 50 comment · 0 complexity · 61a132242814357632ab34a0dc3f8da3 MD5 · raw file
- /*
- * Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
- * Copyright (C) 1999-2001 Internet Software Consortium.
- *
- * Permission to use, copy, modify, and/or distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
- * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
- * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
- * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
- */
- /* $Id: secproto.h,v 1.16 2007/06/19 23:47:17 tbox Exp $ */
- #ifndef DNS_SECPROTO_H
- #define DNS_SECPROTO_H 1
- /*! \file dns/secproto.h */
- #include <isc/lang.h>
- #include <dns/types.h>
- ISC_LANG_BEGINDECLS
- isc_result_t
- dns_secproto_fromtext(dns_secproto_t *secprotop, isc_textregion_t *source);
- /*%<
- * Convert the text 'source' refers to into a DNSSEC security protocol value.
- * The text may contain either a mnemonic protocol name or a decimal protocol
- * number.
- *
- * Requires:
- *\li 'secprotop' is a valid pointer.
- *
- *\li 'source' is a valid text region.
- *
- * Returns:
- *\li ISC_R_SUCCESS on success
- *\li ISC_R_RANGE numeric type is out of range
- *\li DNS_R_UNKNOWN mnemonic type is unknown
- */
- isc_result_t
- dns_secproto_totext(dns_secproto_t secproto, isc_buffer_t *target);
- /*%<
- * Put a textual representation of the DNSSEC security protocol 'secproto'
- * into 'target'.
- *
- * Requires:
- *\li 'secproto' is a valid secproto.
- *
- *\li 'target' is a valid text buffer.
- *
- * Ensures,
- * if the result is success:
- * \li The used space in 'target' is updated.
- *
- * Returns:
- *\li ISC_R_SUCCESS on success
- *\li ISC_R_NOSPACE target buffer is too small
- */
- ISC_LANG_ENDDECLS
- #endif /* DNS_SECPROTO_H */