sopc_time_reference.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you 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.
 */
 
#ifndef SOPC_TIME_REFERENCE_H_
#define SOPC_TIME_REFERENCE_H_
 
#ifndef SOPC_MONOTONIC_CLOCK
#define SOPC_MONOTONIC_CLOCK true
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
typedef uint64_t SOPC_TimeReference;
 
typedef struct SOPC_HighRes_TimeReference SOPC_HighRes_TimeReference;
 
SOPC_TimeReference SOPC_TimeReference_GetCurrent(void);
 
SOPC_TimeReference SOPC_TimeReference_AddMilliseconds(SOPC_TimeReference timeRef, uint64_t ms);
 
int8_t SOPC_TimeReference_Compare(SOPC_TimeReference left, SOPC_TimeReference right);
 
void SOPC_HighRes_TimeReference_GetTime(SOPC_HighRes_TimeReference* t);
 
int64_t SOPC_HighRes_TimeReference_DeltaUs(const SOPC_HighRes_TimeReference* tRef, const SOPC_HighRes_TimeReference* t);
 
void SOPC_HighRes_TimeReference_AddSynchedDuration(SOPC_HighRes_TimeReference* t,
                                                   uint64_t duration_us,
                                                   int32_t offset_us);
 
bool SOPC_HighRes_TimeReference_IsExpired(const SOPC_HighRes_TimeReference* t, const SOPC_HighRes_TimeReference* now);
 
void SOPC_HighRes_TimeReference_SleepUntil(const SOPC_HighRes_TimeReference* date);
 
SOPC_HighRes_TimeReference* SOPC_HighRes_TimeReference_Create(void);
 
void SOPC_HighRes_TimeReference_Copy(SOPC_HighRes_TimeReference* to, const SOPC_HighRes_TimeReference* from);
 
void SOPC_HighRes_TimeReference_Delete(SOPC_HighRes_TimeReference** t);
 
bool SOPC_HighRes_TimeReference_IsExpired(const SOPC_HighRes_TimeReference* t, const SOPC_HighRes_TimeReference* now);
 
#endif // SOPC_TIME_REFERENCE_H_