s_mysql_mysql_keyring_iterator Struct Reference

Keyring iterator component service definition, which enables to iterate over items stored within currently used keyring. More...

#include <keyring_iterator_service.h>

Public Attributes
mysql_service_status_t(*	init )(my_h_keyring_iterator *iterator)
	Initialize an iterator. More...
mysql_service_status_t(*	deinit )(my_h_keyring_iterator iterator)
	Deinitialize an iterator. More...
mysql_service_status_t(*	get )(my_h_keyring_iterator iterator, char *key_id, size_t key_id_size, char *user_id, size_t user_id_size)
	Fetch key info stored under key iterator and move it forward. More...

Detailed Description

Keyring iterator component service definition, which enables to iterate over items stored within currently used keyring.

 my_service<SERVICE_TYPE(mysql_keyring_iterator)> service(
    "mysql_keyring_iterator.mysql_server", m_reg_srv);
 
if (!service.is_valid()) {
  return;
}
 
my_h_keyring_iterator iterator = nullptr;
 
if (service->init(&iterator)) {
  return;
}
 
char key_id[64];
char user_id[64];
 
while (iterator != nullptr && service->get(iterator, key_id, sizeof(key_id)
user_id, sizeof(user_id))
== 0) {
  // Do something with key and user_id values.
}
 
service->deinit(iterator);

Member Data Documentation

deinit

mysql_service_status_t(* s_mysql_mysql_keyring_iterator::deinit) (my_h_keyring_iterator iterator)

Deinitialize an iterator.

Parameters

iterator

Iterator pointer.

Returns

Return values

false	Succeeded.
true	Failed.

See also

plugin_keyring.h

get

mysql_service_status_t(* s_mysql_mysql_keyring_iterator::get) (my_h_keyring_iterator iterator, char *key_id, size_t key_id_size, char *user_id, size_t user_id_size)

Fetch key info stored under key iterator and move it forward.

Parameters

	iterator	Iterator pointer.
[out]	key_id	The buffer pointer for storing key id.
	key_id_size	Size of the key_id buffer.
[out]	user_id	The buffer pointer for storing user id. In case of lack of user id, empty string is returned.
	user_id_size	Size of the user_id buffer.

Returns

Return values

false	Succeeded.
true	Failed.

See also

plugin_keyring.h

init

mysql_service_status_t(* s_mysql_mysql_keyring_iterator::init) (my_h_keyring_iterator *iterator)

Initialize an iterator.

Parameters

[out]

iterator

Iterator pointer.

Returns

Return values

false	Succeeded.
true	Failed.

See also

plugin_keyring.h

---

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

• include/mysql/components/services/keyring_iterator_service.h