org.woodchuck.upcall
--------------------

.. class:: org.woodchuck.upcall

    .. function:: ObjectTransferred (ManagerUUID, ManagerCookie, StreamUUID, StreamCookie, ObjectUUID, ObjectCookie, Status, Instance, Version, Filename, Size, TriggerTarget, TriggerFired)

        Upcall from Woodchuck indicating that a transfer has
        completed.  After processing, the application should
        acknowledge the feedback using FeedbackACK, otherwise, it
        will be resent.  

        - org.freedesktop.DBus.Method.NoReply: true

        :param in ManagerUUID s:
            The manager's UUID.  

        :param in ManagerCookie s:
            The manager's cookie.  

        :param in StreamUUID s:
            The stream's UUID.  

        :param in StreamCookie s:
            The stream's cookie.  

        :param in ObjectUUID s:
            The object's UUID.  

        :param in ObjectCookie s:
            The object's cookie.  

        :param in Status u:
            Whether the transfer was successful or not.  See the status
            argument of :func:`org.woodchuck.object.TransferStatus` for
            the possible values.  

        :param in Instance u:
            The number of transfer attempts (not including this one).
            
            This is the instance number of the feedback.  

        :param in Version usxttub:
            Index and value of the version transfered from the versions
            array (at the time of transfer).  See
            :data:`org.woodchuck.object.Versions`.  

        :param in Filename s:
            The location of the data.  

        :param in Size t:
            The size (in bytes).  

        :param in TriggerTarget t:
            The target time.  

        :param in TriggerFired t:
            The time at which the transfer was attempted.  


    .. function:: StreamUpdate (ManagerUUID, ManagerCookie, StreamUUID, StreamCookie)

        Update the specified stream.
        
        Respond by calling
        :func:`org.woodchuck.stream.UpdateStatus`. 

        - org.freedesktop.DBus.Method.NoReply: true

        :param in ManagerUUID s:
            The manager's UUID.  

        :param in ManagerCookie s:
            The manager's cookie.  

        :param in StreamUUID s:
            The stream's UUID.  

        :param in StreamCookie s:
            The stream's cookie.  


    .. function:: ObjectTransfer (ManagerUUID, ManagerCookie, StreamUUID, StreamCookie, ObjectUUID, ObjectCookie, Version, Filename, Quality)

        Transfer the specified object.
        
        Respond by calling
        :func:`org.woodchuck.object.TransferStatus`. 

        - org.freedesktop.DBus.Method.NoReply: true

        :param in ManagerUUID s:
            The manager's UUID.  

        :param in ManagerCookie s:
            The manager's cookie.  

        :param in StreamUUID s:
            The stream's UUID.  

        :param in StreamCookie s:
            The stream's cookie.  

        :param in ObjectUUID s:
            The object's UUID.  

        :param in ObjectCookie s:
            The object's cookie.  

        :param in Version (usxttub):
            Index and value of the version to transfer from the
            versions array (at the time of the upcall).  See
            :data:`org.woodchuck.object.Versions`. 

        :param in Filename s:
            The value of :data:`org.woodchuck.object.Filename`.  

        :param in Quality u:
            Target quality from 1 (most compressed) to 5 (highest
            available fidelity).  This is useful if all possible
            versions cannot be or are not easily expressed by the
            Version parameter.  


    .. function:: ObjectDeleteFiles (ManagerUUID, ManagerCookie, StreamUUID, StreamCookie, ObjectUUID, ObjectCookie, Files)

        Delete the files associated with the specified object.
        Respond by calling
        :func:`org.woodchuck.object.FilesDeleted`. 

        - org.freedesktop.DBus.Method.NoReply: true

        :param in ManagerUUID s:
            The manager's UUID.  

        :param in ManagerCookie s:
            The manager's cookie.  

        :param in StreamUUID s:
            The stream's UUID.  

        :param in StreamCookie s:
            The stream's cookie.  

        :param in ObjectUUID s:
            The object's UUID.  

        :param in ObjectCookie s:
            The object's cookie.  

        :param in Files a(sbu):
            The list of files associated with this object, as provided
            the call to :func:`org.woodchuck.object.TransferStatus`.
            


