n_clock_sync.h

Go to the documentation of this file.

/*
 * Nilorea Library
 * Copyright (C) 2005-2026 Castagnier Mickael
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef __N_CLOCK_SYNC_HEADER
#define __N_CLOCK_SYNC_HEADER
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "n_common.h"
 
#ifndef N_CLOCK_SYNC_SAMPLE_COUNT
#define N_CLOCK_SYNC_SAMPLE_COUNT 11
#endif
 
#ifndef N_CLOCK_SYNC_INTERVAL
#define N_CLOCK_SYNC_INTERVAL 3.0
#endif
 
#ifndef N_CLOCK_SYNC_BURST_INTERVAL
#define N_CLOCK_SYNC_BURST_INTERVAL 0.5
#endif
 
#ifndef N_CLOCK_SYNC_BURST_SAMPLES
#define N_CLOCK_SYNC_BURST_SAMPLES 5
#endif
 
#ifndef N_CLOCK_SYNC_MAX_RTT
#define N_CLOCK_SYNC_MAX_RTT 10.0
#endif
 
#ifndef N_CLOCK_SYNC_SLEW_SECONDS
#define N_CLOCK_SYNC_SLEW_SECONDS 1.0
#endif
 
typedef struct N_CLOCK_SYNC {
    double offset_samples[N_CLOCK_SYNC_SAMPLE_COUNT];
    double rtt_samples[N_CLOCK_SYNC_SAMPLE_COUNT];
    int sample_index;
    int sample_count;
 
    double estimated_offset;
    double estimated_rtt;
 
    double last_sync_time;
 
    int synthetic;
 
    double offset_prev;
    double offset_change_time;
 
} N_CLOCK_SYNC;
 
N_CLOCK_SYNC* n_clock_sync_new(void);
 
void n_clock_sync_delete(N_CLOCK_SYNC** cs);
 
int n_clock_sync_process_response(N_CLOCK_SYNC* cs, double client_send_time, double server_time, double local_now);
 
void n_clock_sync_seed(N_CLOCK_SYNC* cs, double offset, double rtt);
 
double n_clock_sync_server_time(const N_CLOCK_SYNC* cs, double local_now);
 
int n_clock_sync_should_send(const N_CLOCK_SYNC* cs, double local_now);
 
void n_clock_sync_mark_sent(N_CLOCK_SYNC* cs, double local_now);
 
#ifdef __cplusplus
}
#endif
#endif /* __N_CLOCK_SYNC_HEADER */