org.woodchuck

class org.woodchuck

The top-level interface to Woodchuck.

By default, Woodchuck listens on the session bus. It registers the DBus service name org.woodchuck and uses the object /org/woodchuck.

ManagerRegister(Properties, OnlyIfCookieUnique, UUID)

Register a new manager.

Also see the org.woodchuck.manager.ManagerRegister().

Returns:

The UUID of a new manager object. Manipulate the manager object using org.woodchuck.manager interface and the object /org/woodchuck/manager/UUID.

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

    Dictionary of initial values for the various properties. See the org.woodchuck.manager 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 top-level managers.
  • UUID s (out) – The new manager’s unique identifier (a 16-character alpha-numeric string).
ListManagers(Recursive, Managers)

Return a list of the known managers.

Parameters:
  • Recursive b (in) – Whether to list all descendents (true) or just top-level manager (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 manager. If false, only consider top-level managers.
  • Managers a(sss) (out) – An array of <UUID, HumanReadableName, ParentUUID>.
TransferDesirability(RequestType, Versions, Desirability, Version)

Evaluate the desirability of executing a transfer right now.

Parameters:
  • RequestType u (in) –

    The type of request:

    • 1: User initiated
    • 2: Application initiated
  • Versions a(xttu) (in) – Array of <ExpectedSize, ExpectedTransferUp, ExpectedTransferDown, Utility> tuples. See org.woodchuck.object.Versions for a description.
  • Desirability u (out) –

    The desirability of executing the job now:

    • 0: Avoid if at all possible.
    • 5: Now is acceptable but waiting is better.
    • 9: Now is ideal.
  • Version u (out) – The version to transfer as an index into the passed Versions array. -1 means do not download anything.

Previous topic

Woodchuck

Next topic

org.woodchuck.manager

This Page