org.woodchuck.manager

class org.woodchuck.manager

Object: /org/woodchuck/manager/ManagerUUID

Unregister(OnlyIfNoDescendents)

Unregister this manager and any descendent objects. This does not remove any files; only the metadata stored on the Woodchuck server is deleted.

Parameters:OnlyIfNoDescendents b (in) – If true, fail if this manager has any descendents.
ManagerRegister(Properties, OnlyIfCookieUnique, UUID)

Register a new manager, which is subordinate to this one.

This enables the creation of a manager hierarchy, which is useful for separating a program’s components. For instance, a web browser might have a page cache and a set of files that should be downloaded later. Each should be registered as a child manager to the top-level web browser manager.

Parameters:
  • Properties a{sv} (in) –

    Dictionary of initial values for the various properties.

    The following properties are required: HumanReadableName.

    Note: The a{ss} type is also supported, but then only properties with a string type may be expressed. (This is a concession to dbus-send, as it does not support parameters with the variant type.)

  • OnlyIfCookieUnique b (in) – Only succeed if the supplied cookie is unique among all sibling managers.
  • UUID s (out) – The new manager’s unique identifier (a 16-character alpha-numeric string).
ListManagers(Recursive, Managers)

Return a list of child managers.

Parameters:
  • Recursive b (in) – Whether to list all descendents (true) or just immediate children (false).
  • Managers a(ssss) (out) – An array of <UUID, Cookie, HumanReadableName, ParentUUID>.
LookupManagerByCookie(Cookie, Recursive, Managers)

Return the managers whose Cookie property matches the specified cookie.

Parameters:
  • Cookie s (in) – The cookie to match.
  • Recursive b (in) – If true, consider any descendent manager. If false, only consider immediate children.
  • Managers a(sss) (out) – An array of <UUID, HumanReadableName, ParentUUID>.
StreamRegister(Properties, OnlyIfCookieUnique, UUID)

Register a new stream.

Parameters:
  • Properties a{sv} (in) –

    Dictionary of initial values for the various properties. See the org.woodchuck.stream interface for the list of properties and their meanings.

    The following properties are required: HumanReadableName

    Note: The a{ss} type is also supported, but then only properties with a string type may be expressed. (This is a concession to dbus-send, as it does not support parameters with the variant type.)

  • OnlyIfCookieUnique b (in) – Only succeed if the supplied cookie is unique among all streams belonging to this manager.
  • UUID s (out) – The new stream’s unique identifier.
ListStreams(Streams)

Return a list of streams.

Parameters:Streams a(sss) (out) – An array of <UUID, Cookie, HumanReadableName>.
LookupStreamByCookie(Cookie, Streams)

Return a list of streams with the specified cookie.

Parameters:
  • Cookie s (in) – The cookie to match.
  • Streams a(ss) (out) – An array of <UUID, HumanReadableName>.
FeedbackSubscribe(DescendentsToo, Handle)

Indicate that the calling process would like to receive upcalls pertaining to this manager and (optionally) any of its descendents.

Feedback is sent until FeedbackUnsubscribe() is called.

Parameters:
  • DescendentsToo b (in) – If true, also make upcalls for any descendents.
  • Handle s (out) – An opaque handle, that must be passed to FeedbackUnSubscribe().
FeedbackUnsubscribe(Handle)

Request that Woodchuck cancel the indicated subscription.

Parameters:Handle s (in) – The handle returned by FeedbackSubscribe().
FeedbackAck(ObjectUUID, ObjectInstance)

Ack the feedback with the provided UUID.

Parameters:
  • ObjectUUID s (in) –
  • ObjectInstance u (in) –
ParentUUID

This manager’s parent manager.

HumanReadableName

A human readable name for the manager. When displaying a manager’s human readable name, the human readable name of each of its ancestors as well as its own will be concatenated together. Thus, if the manager’s parent is called “Firefox” and it has a child web cache, the human readable name of the child should be “Web Cache,” not “Firefox Web Cache.” The latter would result in “Firefox Firefox Web Cache” being displayed to the user.

Cookie

A free-form string uninterpreted by the server and passed to any manager upcalls.

By convention, this is set to the application’s DBus name thereby allowing all application’s to easily lookup the UUID of their manager and avoiding any namespace collisions.

DBusServiceName

The DBus service name of the service to start when there is work to do, e.g., streams to update or objects to transfer. See org.woodchuck.upcall.

DBusObject

The DBus object to send upcalls to. This defaults to ‘/org/woodchuck’.

Priority

The priority, relative to other managers with the same parent manager.

RegistrationTime

The time at which the object was registered.

Previous topic

org.woodchuck

Next topic

org.woodchuck.stream

This Page