adding documentation sync
authorVolker Birk <vb@pep-project.org>
Thu, 30 Jan 2020 17:33:12 +0100
branchsync
changeset 43799ca663ee0027
parent 4378 3c491922339d
child 4380 6fd4f3cb625f
adding documentation
src/sync_api.h
     1.1 --- a/src/sync_api.h	Thu Jan 30 15:36:24 2020 +0100
     1.2 +++ b/src/sync_api.h	Thu Jan 30 17:33:12 2020 +0100
     1.3 @@ -115,7 +115,14 @@
     1.4  //      PEP_STATUS_OK or any other value on errror
     1.5  //
     1.6  //  caveat:
     1.7 -//      call that BEFORE you're using any other part of the engine
     1.8 +//      use this function in an adapter where you're processing the sync
     1.9 +//      state machine
    1.10 +//
    1.11 +//      implement start_sync() in this adapter and provide it to the
    1.12 +//      application, so it can trigger startup
    1.13 +//
    1.14 +//      do not return from start_sync() before register_sync_callbacks() was
    1.15 +//      executed
    1.16  
    1.17  DYNAMIC_API PEP_STATUS register_sync_callbacks(
    1.18          PEP_SESSION session,