keyring_common::service_definition::Keyring_keys_metadata_iterator_service_impl Class Reference

#include <keyring_keys_metadata_iterator_service_definition.h>

Static Public Member Functions
static mysql_service_status_t	init (my_h_keyring_keys_metadata_iterator *forward_iterator) noexcept
	Forward iterator initialization. More...
static mysql_service_status_t	deinit (my_h_keyring_keys_metadata_iterator forward_iterator) noexcept
	Iterator deinitialization. More...
static mysql_service_status_t	is_valid (my_h_keyring_keys_metadata_iterator forward_iterator) noexcept
	Check validity of the iterator. More...
static mysql_service_status_t	next (my_h_keyring_keys_metadata_iterator forward_iterator) noexcept
	Move iterator forward. More...
static mysql_service_status_t	get_length (my_h_keyring_keys_metadata_iterator forward_iterator, size_t *data_id_length, size_t *auth_id_length) noexcept
	Fetch length metadata for current key pointed by iterator. More...
static mysql_service_status_t	get (my_h_keyring_keys_metadata_iterator forward_iterator, char *data_id, size_t data_id_length, char *auth_id, size_t auth_id_length) noexcept
	Fetch metadata for current key pointed by iterator. More...

Member Function Documentation

deinit()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_keys_metadata_iterator_service_impl::deinit ( my_h_keyring_keys_metadata_iterator  forward_iterator )

staticnoexcept

Iterator deinitialization.

Note: forward_iterator should not be used after call to deinit

Parameters

[in,out]

forward_iterator

metadata iterator

Returns

Status of the operation

Return values

false	Success
true	Failure

get()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_keys_metadata_iterator_service_impl::get ( my_h_keyring_keys_metadata_iterator  forward_iterator, char *  data_id, size_t  data_id_length, char *  auth_id, size_t  auth_id_length  )

staticnoexcept

Fetch metadata for current key pointed by iterator.

Parameters

[in]	forward_iterator	forward_iterator metadata iterator
[out]	data_id	ID information of current data
[in]	data_id_length	Length of data_id buffer
[out]	auth_id	Owner of the key
[in]	auth_id_length	Length of auth_id buffer

Returns

Status of the operation

Return values

false	Success
true	Failure

get_length()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_keys_metadata_iterator_service_impl::get_length ( my_h_keyring_keys_metadata_iterator  forward_iterator, size_t *  data_id_length, size_t *  auth_id_length  )

staticnoexcept

Fetch length metadata for current key pointed by iterator.

Parameters

[in]	forward_iterator	forward_iterator metadata iterator
[out]	data_id_length	Length of data_id buffer
[out]	auth_id_length	Length of auth_id buffer

Returns

Status of the operation

Return values

false	Success
true	Failure

init()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_keys_metadata_iterator_service_impl::init ( my_h_keyring_keys_metadata_iterator *  forward_iterator )

staticnoexcept

Forward iterator initialization.

Parameters

[out]

forward_iterator

metadata iterator

Returns

Status of the operation

Return values

false	Success
true	Failure

is_valid()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_keys_metadata_iterator_service_impl::is_valid ( my_h_keyring_keys_metadata_iterator  forward_iterator )

staticnoexcept

Check validity of the iterator.

Parameters

[in]

forward_iterator

metadata iterator

Returns

Validty of the iterator

Return values

true	Iterator is valid
false	Iterator is invalid

next()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_keys_metadata_iterator_service_impl::next ( my_h_keyring_keys_metadata_iterator  forward_iterator )

staticnoexcept

Move iterator forward.

Parameters

[in,out]

forward_iterator

metadata iterator

Returns

Status of the operation

Return values

false	Success - indicates that iterator is pointing to next entry
true	Failure - indicates that iterator has reached the end

---

The documentation for this class was generated from the following files:

• components/keyrings/common/component_helpers/include/keyring_keys_metadata_iterator_service_definition.h
• components/keyrings/keyring_file/service_implementation/keyring_keys_metadata_iterator_service_definition.cc
• sql/server_component/mysql_server_keyring_lockable_imp.cc