rcode.h File Reference

#include <isc/lang.h>
#include <dns/types.h>

Go to the source code of this file.

Defines
#define	DNS_RCODE_H   1
Functions
ISC_LANG_BEGINDECLS isc_result_t	dns_rcode_fromtext (dns_rcode_t *rcodep, isc_textregion_t *source)
	Convert the text 'source' refers to into a DNS error value.
isc_result_t	dns_rcode_totext (dns_rcode_t rcode, isc_buffer_t *target)
	Put a textual representation of error 'rcode' into 'target'.
isc_result_t	dns_tsigrcode_fromtext (dns_rcode_t *rcodep, isc_textregion_t *source)
	Convert the text 'source' refers to into a TSIG/TKEY error value.
isc_result_t	dns_tsigrcode_totext (dns_rcode_t rcode, isc_buffer_t *target)
	Put a textual representation of TSIG/TKEY error 'rcode' into 'target'.
isc_result_t	dns_hashalg_fromtext (unsigned char *hashalg, isc_textregion_t *source)
	Convert the text 'source' refers to into a has algorithm value.

---

Detailed Description

Definition in file rcode.h.

---

Define Documentation

#define DNS_RCODE_H   1

Definition at line 21 of file rcode.h.

---

Function Documentation

ISC_LANG_BEGINDECLS isc_result_t dns_rcode_fromtext	(	dns_rcode_t *	rcodep,
		isc_textregion_t *	source
	)

Convert the text 'source' refers to into a DNS error value.

Requires:

• 'rcodep' is a valid pointer.

• 'source' is a valid text region.

Returns:

• ISC_R_SUCCESS on success
• DNS_R_UNKNOWN type is unknown

Definition at line 287 of file rcode.c.

References dns_mnemonic_fromtext(), ISC_R_SUCCESS, and RETERR.

isc_result_t dns_rcode_totext	(	dns_rcode_t	rcode,
		isc_buffer_t *	target
	)

Put a textual representation of error 'rcode' into 'target'.

Requires:

• 'rcode' is a valid rcode.

• 'target' is a valid text buffer.

Ensures:

• If the result is success: The used space in 'target' is updated.

Returns:

• ISC_R_SUCCESS on success
• ISC_R_NOSPACE target buffer is too small

Definition at line 295 of file rcode.c.

References dns_mnemonic_totext().

Referenced by add_bad(), forward_callback(), notify_done(), ns_client_error(), refresh_callback(), resquery_response(), stub_callback(), and update_completed().

isc_result_t dns_tsigrcode_fromtext	(	dns_rcode_t *	rcodep,
		isc_textregion_t *	source
	)

Convert the text 'source' refers to into a TSIG/TKEY error value.

Requires:

• 'rcodep' is a valid pointer.

• 'source' is a valid text region.

Returns:

• ISC_R_SUCCESS on success
• DNS_R_UNKNOWN type is unknown

Definition at line 300 of file rcode.c.

References dns_mnemonic_fromtext(), ISC_R_SUCCESS, and RETERR.

Referenced by fromtext_any_tsig(), and fromtext_tkey().

isc_result_t dns_tsigrcode_totext	(	dns_rcode_t	rcode,
		isc_buffer_t *	target
	)

Put a textual representation of TSIG/TKEY error 'rcode' into 'target'.

Requires:

• 'rcode' is a valid TSIG/TKEY error code.

• 'target' is a valid text buffer.

Ensures:

• If the result is success: The used space in 'target' is updated.

Returns:

• ISC_R_SUCCESS on success
• ISC_R_NOSPACE target buffer is too small

Definition at line 308 of file rcode.c.

References dns_mnemonic_totext().

Referenced by check_tsig_error(), client_request(), totext_any_tsig(), and totext_tkey().

isc_result_t dns_hashalg_fromtext	(	unsigned char *	hashalg,
		isc_textregion_t *	source
	)

Convert the text 'source' refers to into a has algorithm value.

Requires:

• 'hashalg' is a valid pointer.

• 'source' is a valid text region.

Returns:

• ISC_R_SUCCESS on success
• DNS_R_UNKNOWN type is unknown

Definition at line 367 of file rcode.c.

References dns_mnemonic_fromtext(), ISC_R_SUCCESS, and RETERR.

Referenced by fromtext_nsec3(), and fromtext_nsec3param().

---