EDataServer.SourceRegistryWatcher¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
Virtual Methods¶
- Inherited:
|
|
|
|
|
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w/co |
|||
r/w/co |
Data source registry |
Signals¶
- Inherited:
Name |
Short Description |
---|---|
A signal emitted when the source is enabled or added and it had been considered for inclusion with the ESourceRegistryWatcher |
|
A signal emitted when the source is disabled or removed and it had been considered for inclusion with the ESourceRegistryWatcher |
|
A filter signal which verifies whether the source can be considered for inclusion in the watcher or not. |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class EDataServer.SourceRegistryWatcher(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Contains only private data that should be read and manipulated using the functions below.
- classmethod new(registry, extension_name)¶
- Parameters:
registry (
EDataServer.SourceRegistry
) – anEDataServer.SourceRegistry
extension_name (
str
orNone
) – optional extension name to filter sources with, orNone
- Returns:
- Return type:
Creates a new
EDataServer.SourceRegistryWatcher
instance.The extension_name can be used as a complementary filter to
EDataServer.SourceRegistryWatcher
::filter
signal.New in version 3.26.
- get_extension_name()¶
- Returns:
The extension name passed to
EDataServer.SourceRegistryWatcher.new
().- Return type:
New in version 3.26.
- get_registry()¶
- Returns:
- Return type:
Returns the
EDataServer.SourceRegistry
passed toEDataServer.SourceRegistryWatcher.new
().New in version 3.26.
- reclaim()¶
Reclaims all available sources satisfying the
EDataServer.SourceRegistryWatcher
::filter
signal. It doesn’t notify about disappeared sources, it notifies only on those appeared.New in version 3.26.
- do_appeared(source) virtual¶
- Parameters:
source (
EDataServer.Source
) –
- do_disappeared(source) virtual¶
- Parameters:
source (
EDataServer.Source
) –
- do_filter(source) virtual¶
- Parameters:
source (
EDataServer.Source
) –- Return type:
Signal Details¶
- EDataServer.SourceRegistryWatcher.signals.appeared(source_registry_watcher, source)¶
- Signal Name:
appeared
- Flags:
- Parameters:
source_registry_watcher (
EDataServer.SourceRegistryWatcher
) – The object which received the signalsource (
EDataServer.Source
) – theEDataServer.Source
which appeared
A signal emitted when the source is enabled or added and it had been considered for inclusion with the ESourceRegistryWatcher
::filter
signal.New in version 3.26.
- EDataServer.SourceRegistryWatcher.signals.disappeared(source_registry_watcher, source)¶
- Signal Name:
disappeared
- Flags:
- Parameters:
source_registry_watcher (
EDataServer.SourceRegistryWatcher
) – The object which received the signalsource (
EDataServer.Source
) – theEDataServer.Source
which disappeared
A signal emitted when the source is disabled or removed and it had been considered for inclusion with the ESourceRegistryWatcher
::filter
signal earlier.New in version 3.26.
- EDataServer.SourceRegistryWatcher.signals.filter(source_registry_watcher, source)¶
- Signal Name:
filter
- Flags:
- Parameters:
source_registry_watcher (
EDataServer.SourceRegistryWatcher
) – The object which received the signalsource (
EDataServer.Source
) – theEDataServer.Source
to filter
- Returns:
- Return type:
A filter signal which verifies whether the source can be considered for inclusion in the watcher or not. If none is set then all the sources are included.
New in version 3.26.
Property Details¶
- EDataServer.SourceRegistryWatcher.props.extension_name¶
- Name:
extension-name
- Type:
- Default Value:
- Flags:
Optional extension name, to consider sources with only. It can be
None
, to check for all sources. This is a complementary filter toEDataServer.SourceRegistryWatcher
::filter
signal.New in version 3.26.
- EDataServer.SourceRegistryWatcher.props.registry¶
- Name:
registry
- Type:
- Default Value:
- Flags:
The
EDataServer.SourceRegistry
managesEDataServer.Source
instances.New in version 3.26.