isc::dns::TSIGKeyRing::FindResult Struct Reference

A helper structure to represent the search result of TSIGKeyRing::find(). More...

#include <tsigkey.h>

Public Member Functions
	FindResult (Result param_code, const TSIGKey *param_key)

Public Attributes
const Result	code
const TSIGKey *const	key

Detailed Description

A helper structure to represent the search result of TSIGKeyRing::find().

This is a straightforward pair of the result code and a pointer to the found key to represent the result of find(). We use this in order to avoid overloading the return value for both the result code ("success" or "not found") and the found object, i.e., avoid using NULL to mean "not found", etc.

This is a simple value class with no internal state, so for convenience we allow the applications to refer to the members directly.

See the description of find() for the semantics of the member variables.

Definition at line 270 of file tsigkey.h.

Constructor & Destructor Documentation

isc::dns::TSIGKeyRing::FindResult::FindResult ( Result  param_code, const TSIGKey *  param_key  )

inline

Definition at line 271 of file tsigkey.h.

Member Data Documentation

const Result isc::dns::TSIGKeyRing::FindResult::code

Definition at line 274 of file tsigkey.h.

const TSIGKey* const isc::dns::TSIGKeyRing::FindResult::key

Definition at line 275 of file tsigkey.h.

---

The documentation for this struct was generated from the following file:

• tsigkey.h