On Mon, Dec 19, 2011 at 12:26 PM, Patrick Ohly <[email protected]> wrote:
> On Mo, 2011-12-19 at 11:02 +0100, Chris Kühl wrote:
>> When looking into why the Session has a GetConfigs dbus method, I
>> noticed that there are several dbus methods which are not documented
>> in syncevo-session-full.xml. This includes Attach which is actually
>> mention but not properly documented in that file.
>
> Good catch.

So what is the reason for GetConfigs in the DBus Session API? It seems
to be identical to Server.GetConfigs.

>
>> Is this just a case of the docs being out of sync or are some of these
>> methods not intended to be in the session interface?
>
> The docs are incomplete. In the patch which introduces the
> implementation, I added some comments to the documentation, but I missed
> completely that the actual documentation for Attach() and Detach() were
> missing.
>
> What is missing is something like:
>
>    <method name="Attach">
>      <doc:doc>
>        <doc:description>
>          Prevents destruction of the session until the client
>          detaches or quits. Implemented with a counter, so each
>          Attach() must be matched by a Detach() to free the session.
>          Meant to be used by clients which want to follow the
>          progress of a session started by the daemon or some other
>          client. StartSession() automatically includes one Attach()
>          call, so typically the client which created a session never
>          calls Attach() and Detach() only once.
>        </doc:description>
>    </method>
>
>    <method name="Detach">
>      <doc:doc>
>        <doc:description>
>          Each Attach() or StartSession() must be matched by one
>          Detach() call, otherwise the session will not be
>          destructed. A client that quits without these calls will be
>          detached automatically.
>        </doc:description>
>      </doc:doc>
>    </method>
>
>
> For the record, here's the commit:
>

Ok, thanks.

Cheers,
Chris
_______________________________________________
SyncEvolution mailing list
[email protected]
http://lists.syncevolution.org/listinfo/syncevolution

Reply via email to