![]() |
![]() |
![]() |
librygel-server Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites | Known Implementations | Properties |
void rygel_searchable_container_search (RygelSearchableContainer *self
,RygelSearchExpression *expression
,guint offset
,guint max_count
,const gchar *sort_criteria
,GCancellable *cancellable
,GAsyncReadyCallback _callback_
,gpointer _user_data_
); RygelMediaObjects * rygel_searchable_container_search_finish (RygelSearchableContainer *self
,GAsyncResult *_res_
,guint *total_matches
,GError **error
); void rygel_searchable_container_simple_search (RygelSearchableContainer *self
,RygelSearchExpression *expression
,guint offset
,guint max_count
,const gchar *sort_criteria
,GCancellable *cancellable
,GAsyncReadyCallback _callback_
,gpointer _user_data_
); RygelMediaObjects * rygel_searchable_container_simple_search_finish (RygelSearchableContainer *self
,GAsyncResult *_res_
,guint *total_matches
,GError **error
); void rygel_searchable_container_find_object (RygelSearchableContainer *self
,const gchar *id
,GCancellable *cancellable
,GAsyncReadyCallback _callback_
,gpointer _user_data_
); RygelMediaObject * rygel_searchable_container_find_object_finish (RygelSearchableContainer *self
,GAsyncResult *_res_
,GError **error
); GeeArrayList * rygel_searchable_container_get_search_classes (RygelSearchableContainer *self
); void rygel_searchable_container_set_search_classes (RygelSearchableContainer *self
,GeeArrayList *value
); RygelSearchableContainer; struct RygelSearchableContainerIface;
Classes that implement this interface can, for instance:
Allow backends to implement a UPnP Search call using native searching (such as SQL or SPARQL queries).
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),
void rygel_searchable_container_search (RygelSearchableContainer *self
,RygelSearchExpression *expression
,guint offset
,guint max_count
,const gchar *sort_criteria
,GCancellable *cancellable
,GAsyncReadyCallback _callback_
,gpointer _user_data_
);
Recursively searches for all media objects that satisfy the given search expression in this container.
See also: rygel_searchable_container_search_finish()
|
the RygelSearchableContainer instance |
|
the search expression or null for wildcard. [in][allow-none] |
|
zero-based index of the first object to return. [in] |
|
maximum number of objects to return. [in] |
|
sets it to the actual number of objects that satisfy. [out] |
|
optional cancellable for this operation. [in][allow-none] |
|
callback to call when the request is satisfied. [scope async] |
|
the data to pass to _callback_ function. [closure]
|
RygelMediaObjects * rygel_searchable_container_search_finish (RygelSearchableContainer *self
,GAsyncResult *_res_
,guint *total_matches
,GError **error
);
Recursively searches for all media objects that satisfy the given search expression in this container.
See also: rygel_searchable_container_search()
|
the RygelSearchableContainer instance |
|
a GAsyncResult |
|
location to store the error occuring, or NULL to ignore |
Returns : |
A list of matching media objects or null if no object matched. |
void rygel_searchable_container_simple_search (RygelSearchableContainer *self
,RygelSearchExpression *expression
,guint offset
,guint max_count
,const gchar *sort_criteria
,GCancellable *cancellable
,GAsyncReadyCallback _callback_
,gpointer _user_data_
);
Utility method that retrieves all children and recursively searches for all media objects that satisfy the given search expression in this container.
See also: rygel_searchable_container_simple_search_finish()
|
the RygelSearchableContainer instance |
|
the search expression or `null` for wildcard. [in][allow-none] |
|
zero-based index of the first object to return. [in] |
|
maximum number of objects to return. [in] |
|
sets it to the actual number of objects that satisfy the given search expression. If it is not possible to compute this value (in a timely mannger), it is set to '0'. [out] |
|
optional cancellable for this operation. [in][allow-none] |
|
callback to call when the request is satisfied. [scope async] |
|
the data to pass to _callback_ function. [closure]
|
RygelMediaObjects * rygel_searchable_container_simple_search_finish (RygelSearchableContainer *self
,GAsyncResult *_res_
,guint *total_matches
,GError **error
);
Utility method that retrieves all children and recursively searches for all media objects that satisfy the given search expression in this container.
See also: rygel_searchable_container_simple_search()
|
the RygelSearchableContainer instance |
|
a GAsyncResult |
|
location to store the error occuring, or NULL to ignore |
Returns : |
A list of media objects. |
void rygel_searchable_container_find_object (RygelSearchableContainer *self
,const gchar *id
,GCancellable *cancellable
,GAsyncReadyCallback _callback_
,gpointer _user_data_
);
Recursively searches for media object with the given id in this container.
See also: rygel_searchable_container_find_object_finish()
|
function to call when result is ready |
|
the RygelSearchableContainer instance |
|
ID of the media object to search for. [in] |
|
optional cancellable for this operation. [in][allow-none] |
|
callback to call when the request is satisfied. [scope async] |
|
the data to pass to _callback_ function. [closure]
|
RygelMediaObject * rygel_searchable_container_find_object_finish (RygelSearchableContainer *self
,GAsyncResult *_res_
,GError **error
);
Recursively searches for media object with the given id in this container.
See also: rygel_searchable_container_find_object()
|
the RygelSearchableContainer instance |
|
a GAsyncResult |
|
location to store the error occuring, or NULL to ignore |
Returns : |
the found media object. |
GeeArrayList * rygel_searchable_container_get_search_classes
(RygelSearchableContainer *self
);
Get and return the current value of the "search-classes" property.
|
the RygelSearchableContainer instance to query |
Returns : |
the value of the "search-classes" property |
void rygel_searchable_container_set_search_classes (RygelSearchableContainer *self
,GeeArrayList *value
);
Set the value of the "search-classes" property to value
.
|
the RygelSearchableContainer instance to modify |
|
the new value of the "search-classes" property |
typedef struct _RygelSearchableContainer RygelSearchableContainer;
The base class for searchable containers.
Classes that implement this interface can, for instance:
Allow backends to implement a UPnP Search call using native searching (such as SQL or SPARQL queries).
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 { 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.
the parent interface structure | |
virtual method called by
|
|
asynchronous finish function for search , called by
|
|
getter method for the abstract property "search-classes" | |
setter method for the abstract property "search-classes" |