MySQL  8.0.18
Source Code Documentation
s_mysql_registry_metadata_enumerate Struct Reference

Service for listing all metadata for a Service Implementation specified by the given iterator. More...

#include <registry.h>

Public Attributes

mysql_service_status_t(* create )(my_h_service_iterator iterator, my_h_service_metadata_iterator *out_iterator)
 Creates a iterator that iterates through all metadata for the object pointed by the specified iterator. More...
 
mysql_service_status_t(* get )(my_h_service_metadata_iterator iterator, const char **name, const char **value)
 Gets the key and value of the metadata pointed to by the specified iterator. More...
 
mysql_service_status_t(* next )(my_h_service_metadata_iterator iterator)
 Advances specified iterator to next element. More...
 
mysql_service_status_t(* is_valid )(my_h_service_metadata_iterator iterator)
 Checks if specified iterator is valid, i.e. More...
 
void(* release )(my_h_service_metadata_iterator iterator)
 Releases the specified iterator. More...
 

Detailed Description

Service for listing all metadata for a Service Implementation specified by the given iterator.

Member Data Documentation

◆ create

mysql_service_status_t(* s_mysql_registry_metadata_enumerate::create) (my_h_service_iterator iterator, my_h_service_metadata_iterator *out_iterator)

Creates a iterator that iterates through all metadata for the object pointed by the specified iterator.

If successful it leaves read lock on the registry until the iterator is released.

Parameters
iteratorA iterator that points to object to get the metadata iterator for.
[out]out_iteratorPointer to metadata iterator handle.
Returns
Status of performed operation
Return values
falsesuccess
truefailure

◆ get

mysql_service_status_t(* s_mysql_registry_metadata_enumerate::get) (my_h_service_metadata_iterator iterator, const char **name, const char **value)

Gets the key and value of the metadata pointed to by the specified iterator.

The pointers returned will last at least up to the moment of call to the release() method on the iterator.

Parameters
iteratorMetadata iterator handle.
[out]out_nameA pointer to the string with the key to set the result pointer to.
[out]out_valueA pointer to the string with the metadata value to set the result pointer to.
Returns
Status of performed operation
Return values
falsesuccess
trueFailure, may be caused when called on the iterator that went through all values already.

◆ is_valid

mysql_service_status_t(* s_mysql_registry_metadata_enumerate::is_valid) (my_h_service_metadata_iterator iterator)

Checks if specified iterator is valid, i.e.

have not reached one-past-last element.

Parameters
iteratorMetadata iterator handle.
Returns
Validity of iterator
Return values
falseValid
trueInvalid or reached one-past-last element.

◆ next

mysql_service_status_t(* s_mysql_registry_metadata_enumerate::next) (my_h_service_metadata_iterator iterator)

Advances specified iterator to next element.

Will fail if it reaches one-past-last element.

Parameters
iteratorMetadata iterator handle.
Returns
Status of performed operation
Return values
falsesuccess
trueFailure, may be caused when called on iterator that was on last element.

◆ release

void(* s_mysql_registry_metadata_enumerate::release) (my_h_service_metadata_iterator iterator)

Releases the specified iterator.

Releases read lock on the registry.

Parameters
iteratorMetadata iterator handle.
Returns
Status of performed operation
Return values
falsesuccess
truefailure

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