TimeSyncClient.h

Go to the documentation of this file.

/*
 * Copyright (C) Photon Vision.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <chrono>
#include <cstdlib>
#include <functional>
#include <memory>
#include <mutex>
#include <string>
 
#include <wpi/math/filter/MedianFilter.hpp>
#include <wpi/net/EventLoopRunner.hpp>
#include <wpi/net/uv/Buffer.hpp>
#include <wpi/net/uv/Timer.hpp>
#include <wpi/net/uv/Udp.hpp>
#include <wpi/util/Logger.hpp>
 
#include "TimeSyncStructs.h"
 
namespace wpi {
namespace tsp {
 
class TimeSyncClient {
 public:
  struct Metadata {
    int64_t offset{0};
    int64_t rtt2{0};
    size_t pingsSent{0};
    size_t pongsReceived{0};
    uint64_t lastPongTime{0};
  };
 
 private:
  using SharedUdpPtr = std::shared_ptr<wpi::net::uv::Udp>;
  using SharedTimerPtr = std::shared_ptr<wpi::net::uv::Timer>;
 
  wpi::net::EventLoopRunner m_loopRunner{};
 
  wpi::util::Logger m_logger;
  std::function<uint64_t()> m_timeProvider;
 
  SharedUdpPtr m_udp;
  SharedTimerPtr m_pingTimer;
 
  std::string m_serverIP;
  int m_serverPort;
 
  std::chrono::milliseconds m_loopDelay;
 
  std::mutex m_offsetMutex{};
  Metadata m_metadata{};
 
  // We only allow the most recent ping to stay alive, so only keep track of it
  TspPing m_lastPing{};
 
  // 30s is a reasonable guess
  wpi::math::MedianFilter<int64_t> m_lastOffsets{30};
 
  void Tick();
 
  void UdpCallback(wpi::net::uv::Buffer& buf, size_t nbytes,
                   const sockaddr& sender, unsigned flags);
 
 public:
  TimeSyncClient(std::string_view server, int remote_port,
                 std::chrono::milliseconds ping_delay);
 
  void Start();
  void Stop();
  int64_t GetOffset();
  Metadata GetMetadata();
 
  // public for testability
  void UpdateStatistics(uint64_t pong_local_time, wpi::tsp::TspPing ping,
                        wpi::tsp::TspPong pong);
};
 
}  // namespace tsp
}  // namespace wpi