ContextFilter

ContextFilter

Object Hierarchy:

Description:

[ CCode ( type_id = "gupnp_context_filter_get_type ()" ) ]
[ Version ( since = "1.4.0" ) ]
public class ContextFilter : Object

Network context filter, used by [class@GUPnP.

ContextManager]

ContextFilter handles network filtering. It provides API to manage a list of entries that will be used to positive filter networks. The ContextFilter could be enabled or not. If it's enabled but the entries list is empty, it behaves as if being disabled.

The GUPnPContextFilter is used with the [class@GUPnP.ContextManager] to narrow down the contexts that are notified by it.

Contexts can be filtered by the following criteria:

Their IP addresses
The network device they will live on
The name of the network the context would join

To add or modify a context filter, you need to retrieve the current context filter from the context manger using [ method@GUPnP.ContextManager.get_context_filter].

By default, a context filter is empty and disabled.

For example, to only react to contexts that are appearing on eth0 or when being in the WiFi network with the SSID "HomeNetwork", and on IPv6 localhost, you should do:

```c GUPnPContextFilter* filter;

filter = gupnp_context_manager_get_context_filter (manager); const char *filter_entries[] = { "eth0", "HomeNetwork", "::1", NULL }; gupnp_context_filter_add_entryv (filter, filter_entries); gupnp_context_filter_set_enabled (filter, TRUE); ```

Namespace: GUPnP

Package: gupnp-1.6

Content:

Properties:

public bool enabled { get; set construct; }
Whether this context filter is active or not.
public List<string> entries { owned get; construct; }
A list of items to filter for.

Creation methods:

protected ContextFilter ()

Methods:

public bool add_entry (string entry)
Add entry in the list of valid criteria used by this to filter networks.
public void add_entryv (string[] entries)
Add a list of entries to a ContextFilter.
public bool check_context (Context context)
It will check if the context is allowed or not.
public void clear ()
Remove all entries from List that compose the context filter.
public bool get_enabled ()
Return the status of the ContextFilter
public List<unowned string>? get_entries ()
Get the List of entries that compose the context filter.
public bool is_empty ()
Return the state of the entries list of ContextFilter
public bool remove_entry (string entry)
Remove entry in the list of valid criteria used by this to filter networks.
public void set_enabled (bool enable)
Enable or disable the ContextFilter to perform the network filtering.

Inherited Members:

All known members inherited from class GLib.Object