Line data    Source code

       1              : /*
       2              :  *  Copyright (C) 2004-2026 Savoir-faire Linux Inc.
       3              :  *
       4              :  *  This program is free software: you can redistribute it and/or modify
       5              :  *  it under the terms of the GNU General Public License as published by
       6              :  *  the Free Software Foundation, either version 3 of the License, or
       7              :  *  (at your option) any later version.
       8              :  *
       9              :  *  This program is distributed in the hope that it will be useful,
      10              :  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
      11              :  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
      12              :  *  GNU General Public License for more details.
      13              :  *
      14              :  *  You should have received a copy of the GNU General Public License
      15              :  *  along with this program. If not, see <https://www.gnu.org/licenses/>.
      16              :  */
      17              : #pragma once
      18              : 
      19              : #include "jamidht/jamiaccount.h"
      20              : 
      21              : namespace jami {
      22              : 
      23              : class SyncModule
      24              : {
      25              : public:
      26              :     SyncModule(const std::shared_ptr<JamiAccount>& account);
      27          681 :     ~SyncModule() = default;
      28              : 
      29              :     /**
      30              :      * Store a new Sync connection
      31              :      * @param socket    The new sync channel
      32              :      * @param peerId    The contact who owns the device
      33              :      * @param deviceId  Device linked to that transport
      34              :      */
      35              :     void cacheSyncConnection(std::shared_ptr<dhtnet::ChannelSocket>&& socket,
      36              :                              const std::string& peerId,
      37              :                              const DeviceId& deviceId);
      38              : 
      39              :     bool isConnected(const DeviceId& deviceId) const;
      40              : 
      41              :     /**
      42              :      * Send sync to all connected devices
      43              :      * @param syncMsg       Default message
      44              :      * @param deviceId      If we need to filter on a device
      45              :      */
      46              :     void syncWithConnected(const std::shared_ptr<SyncMsg>& syncMsg = nullptr, const DeviceId& deviceId = {});
      47              : 
      48              :     /**
      49              :      * Local sync-version tracking.
      50              :      *
      51              :      * The version counter and the per-device watermarks are purely local: they
      52              :      * are never transmitted on the network. They are only used to decide
      53              :      * whether a sync connection must be (re)established with a given device, so
      54              :      * that devices (especially mobiles) are not woken up when there is nothing
      55              :      * new to synchronize.
      56              :      */
      57              : 
      58              :     /// Increment the local sync version (to be called on any contact or
      59              :     /// conversation list change, whether local or learned from a peer) and
      60              :     /// persist it. Returns the new version.
      61              :     uint64_t bumpVersion();
      62              : 
      63              :     /// Current local sync version.
      64              :     uint64_t currentVersion() const;
      65              : 
      66              :     /// True if @p deviceId may be missing local list state, i.e. it was never
      67              :     /// synced or was last synced at an older version than the current one.
      68              :     bool needsSync(const DeviceId& deviceId) const;
      69              : 
      70              :     /// Record that @p deviceId has received local state up to @p version.
      71              :     void markSynced(const DeviceId& deviceId, uint64_t version);
      72              : 
      73              : private:
      74              :     class Impl;
      75              :     std::shared_ptr<Impl> pimpl_;
      76              : };
      77              : 
      78              : } // namespace jami