sopc_event_timer_manager.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_EVENT_TIMER_MANAGER_H_
#define SOPC_EVENT_TIMER_MANAGER_H_
 
#include "sopc_date_time.h"
#include "sopc_event_handler.h"
 
#ifndef SOPC_TIMER_RESOLUTION_MS
#define SOPC_TIMER_RESOLUTION_MS 50
#endif
 
#if SOPC_TIMER_RESOLUTION_MS <= 0
#error "Timer resolution cannot be <= 0"
#endif
 
void SOPC_EventTimer_Initialize(void);
 
void SOPC_EventTimer_PreClear(void);
 
void SOPC_EventTimer_Clear(void);
 
uint32_t SOPC_EventTimer_Create(SOPC_EventHandler* eventHandler, SOPC_LooperEvent event, uint64_t msDelay);
 
uint32_t SOPC_EventTimer_CreatePeriodic(SOPC_EventHandler* eventHandler, SOPC_LooperEvent event, uint64_t msPeriod);
 
bool SOPC_EventTimer_ModifyPeriodic(uint32_t timerId, uint64_t msPeriod);
 
void SOPC_EventTimer_Cancel(uint32_t timerId);
 
#endif /* SOPC_EVENT_TIMER_MANAGER_H_ */