MySQL 8.3.0
Source Code Documentation
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_iteratorMetadata iterator handle
Returns
Status of iterator deinitialization
Return values
falseSuccess
trueFailure

◆ 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_iteratorMetadata iterator handle
[out]key_bufferOutput buffer for key
[in]key_buffer_lengthLength of key buffer
[out]value_bufferOutput buffer for value
[in]value_buffer_lengthLength of value buffer
Returns
Status of fetch operation
Return values
falseSuccess
trueFailure

◆ 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_iteratorMetadata iterator handle
[out]key_buffer_lengthLength of the key buffer
[out]value_buffer_lengthLength of the value buffer
Returns
Get length information about key and value
Return values
falseSuccess check out parameters
trueFailure

◆ 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_iteratorMetadata iterator handle
Returns
Status of iterator initialization
Return values
falseSuccess
trueFailure

◆ 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_iteratorMetadata iterator handle
Returns
Validity of the the iterator
Return values
trueIterator valid
falseIterator 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_iteratorMetadata iterator handle
Returns
Status of operation
Return values
falseSuccess
trueFailure

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