keyring_common::service_definition::Keyring_metadata_query_service_impl Class Reference

#include <keyring_metadata_query_service_definition.h>

Static Public Member Functions
static mysql_service_status_t	is_initialized () noexcept
	Returns status of the keyring component. More...
static mysql_service_status_t	init (my_h_keyring_component_metadata_iterator *metadata_iterator) noexcept
	Initialize metadata iterator. More...
static mysql_service_status_t	deinit (my_h_keyring_component_metadata_iterator metadata_iterator) noexcept
	Deinitialize metadata iterator. More...
static mysql_service_status_t	is_valid (my_h_keyring_component_metadata_iterator metadata_iterator) noexcept
	Check validity of iterator. More...
static mysql_service_status_t	next (my_h_keyring_component_metadata_iterator metadata_iterator) noexcept
	Move iterator forward. More...
static mysql_service_status_t	get_length (my_h_keyring_component_metadata_iterator metadata_iterator, size_t *key_buffer_length, size_t *value_buffer_length) noexcept
	Get length information about metadata key and value. More...
static mysql_service_status_t	get (my_h_keyring_component_metadata_iterator metadata_iterator, char *key_buffer, size_t key_buffer_length, char *value_buffer, size_t value_buffer_length) noexcept
	Get name and value of metadata at current position. More...

Member Function Documentation

deinit()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_metadata_query_service_impl::deinit ( my_h_keyring_component_metadata_iterator  metadata_iterator )

staticnoexcept

Deinitialize metadata iterator.

Parameters

[in,out]

metadata_iterator

Metadata iterator handle

Returns

Status of iterator deinitialization

Return values

false	Success
true	Failure

get()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_metadata_query_service_impl::get ( my_h_keyring_component_metadata_iterator  metadata_iterator, char *  key_buffer, size_t  key_buffer_length, char *  value_buffer, size_t  value_buffer_length  )

staticnoexcept

Get name and value of metadata at current position.

Parameters

[in]	metadata_iterator	Metadata iterator handle
[out]	key_buffer	Output buffer for key
[in]	key_buffer_length	Length of key buffer
[out]	value_buffer	Output buffer for value
[in]	value_buffer_length	Length of value buffer

Returns

Status of fetch operation

Return values

false	Success
true	Failure

get_length()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_metadata_query_service_impl::get_length ( my_h_keyring_component_metadata_iterator  metadata_iterator, size_t *  key_buffer_length, size_t *  value_buffer_length  )

staticnoexcept

Get length information about metadata key and value.

Parameters

[in]	metadata_iterator	Metadata iterator handle
[out]	key_buffer_length	Length of the key buffer
[out]	value_buffer_length	Length of the value buffer

Returns

Get length information about key and value

Return values

false	Success check out parameters
true	Failure

init()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_metadata_query_service_impl::init ( my_h_keyring_component_metadata_iterator *  metadata_iterator )

staticnoexcept

Initialize metadata iterator.

Parameters

[out]

metadata_iterator

Metadata iterator handle

Returns

Status of iterator initialization

Return values

false	Success
true	Failure

is_initialized()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_metadata_query_service_impl::is_initialized ( )

staticnoexcept

Returns status of the keyring component.

is_valid()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_metadata_query_service_impl::is_valid ( my_h_keyring_component_metadata_iterator  metadata_iterator )

staticnoexcept

Check validity of iterator.

Parameters

[in]

metadata_iterator

Metadata iterator handle

Returns

Validity of the the iterator

Return values

true	Iterator valid
false	Iterator invalid

next()

mysql_service_status_t keyring_lockable::keyring_common::service_definition::Keyring_metadata_query_service_impl::next ( my_h_keyring_component_metadata_iterator  metadata_iterator )

staticnoexcept

Move iterator forward.

Parameters

[in,out]

metadata_iterator

Metadata iterator handle

Returns

Status of operation

Return values

false	Success
true	Failure

---

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

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