RygelSearchableContainer

RygelSearchableContainer — The base class for searchable containers.

Types and Values

Description

Classes that implement this interface can, for instance:

  1. Allow backends to implement a UPnP Search call using native searching (such as SQL or SPARQL queries).

  2. Implement searching via the naïve default implementation provided by rygel_searchable_container_simple_search(), which does a recursive tree walk.

The search_classes property lists what information this container may be searched for. It is mapped to upnp:searchClass (with includeDerived assumed to be false),

Functions

Types and Values

RygelSearchableContainer

typedef struct _RygelSearchableContainer RygelSearchableContainer;

The base class for searchable containers.

Classes that implement this interface can, for instance:

  1. Allow backends to implement a UPnP Search call using native searching (such as SQL or SPARQL queries).

  2. Implement searching via the naïve default implementation provided by rygel_searchable_container_simple_search(), which does a recursive tree walk.

The search_classes property lists what information this container may be searched for. It is mapped to upnp:searchClass (with includeDerived assumed to be false),


struct RygelSearchableContainerIface

struct RygelSearchableContainerIface {
	GTypeInterface parent_iface;
	void (*search) (RygelSearchableContainer* self, RygelSearchExpression* expression, guint offset, guint max_count, const gchar* sort_criteria, GCancellable* cancellable, GAsyncReadyCallback _callback_, gpointer _user_data_);
	RygelMediaObjects* (*search_finish) (RygelSearchableContainer* self, GAsyncResult* _res_, guint* total_matches, GError** error);
	GeeArrayList* (*get_search_classes) (RygelSearchableContainer* self);
	void (*set_search_classes) (RygelSearchableContainer* self, GeeArrayList* value);
};

Interface for creating RygelSearchableContainer implementations.

Members

GTypeInterface parent_iface;

the parent interface structure

 

search ()

virtual method called by rygel_searchable_container_search()

 

search_finish ()

asynchronous finish function for search, called by rygel_searchable_container_search()

 

get_search_classes ()

getter method for the abstract property "search-classes"

 

set_search_classes ()

setter method for the abstract property "search-classes"