s_mysql_reference_caching_channel_ignore_list Struct Reference

A service to maintain an "ignore list" for reference caches. More...

#include <reference_caching.h>

Public Attributes
mysql_service_status_t(*	add )(reference_caching_channel channel, const char *implementation_name)
	Adds an implementation name to the ignore list. More...
mysql_service_status_t(*	remove )(reference_caching_channel channel, const char *implementation_name)
	Remove an implementation name to the ignore list. More...
mysql_service_status_t(*	clear )(reference_caching_channel channel)
	Empty the ignore list. More...

Detailed Description

A service to maintain an "ignore list" for reference caches.

When a service implementation is on that ignore list it will never be added to any reference caches when they're filled in even if the service implementation is in the registry and implements the service the reference caching channel is operating on.

This is just a list of "implementations", i.e. the part of the service implementation name after the dot. The channel already has the name of the service so a full implementation name can be constructed if needed.

Member Data Documentation

add

mysql_service_status_t(* s_mysql_reference_caching_channel_ignore_list::add) (reference_caching_channel channel, const char *implementation_name)

Adds an implementation name to the ignore list.

Parameters

channel	the channel to add the ignored implementation to.
implementation_name	the second part of the service implementation name (the part after the dot).

Return values

false	successfully added
true	error adding (e.g. the ignore is present etc.

clear

mysql_service_status_t(* s_mysql_reference_caching_channel_ignore_list::clear) (reference_caching_channel channel)

Empty the ignore list.

Parameters

channel

the channel to remove the ignored implementation from.

Return values

false	successfully removed all ignores
true	error removing the ignores. State unknown.

remove

mysql_service_status_t(* s_mysql_reference_caching_channel_ignore_list::remove) (reference_caching_channel channel, const char *implementation_name)

Remove an implementation name to the ignore list.

Parameters

channel	the channel to remove the ignored implementation from.
implementation_name	the second part of the service implementation name (the part after the dot).

Return values

false	successfully removed
true	error removing or not present

---

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

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