sopc_sk_scheduler.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_SK_SCHEDULER_H_
#define SOPC_SK_SCHEDULER_H_
 
#include "sopc_sk_scheduler.h"
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sopc_builtintypes.h"
#include "sopc_enums.h"
#include "sopc_sk_builder.h"
#include "sopc_sk_manager.h"
#include "sopc_sk_provider.h"
 
// minimal period for update (2s). Period used when no keys are available
#define SOPC_SK_SCHEDULER_UPDATE_TIMER_MIN 2000
 
// maximal period for update (by default no max)
#define SOPC_SK_SCHEDULER_UPDATE_TIMER_MAX UINT32_MAX
 
typedef struct SOPC_SKscheduler SOPC_SKscheduler;
 
typedef SOPC_ReturnStatus (*SOPC_SKscheduler_AddTask_Func)(SOPC_SKscheduler* sko,
                                                           SOPC_SKBuilder* skb,
                                                           SOPC_SKProvider* skp,
                                                           SOPC_SKManager* skm,
                                                           uint32_t msPeriod);
typedef SOPC_ReturnStatus (*SOPC_SKscheduler_Start_Func)(SOPC_SKscheduler* sko);
typedef void (*SOPC_SKscheduler_StopAndClear_Func)(SOPC_SKscheduler* sko);
 
struct SOPC_SKscheduler
{
    SOPC_SKscheduler_AddTask_Func ptrAddTask;
    SOPC_SKscheduler_Start_Func ptrStart;
    SOPC_SKscheduler_StopAndClear_Func ptrClear;
    void* data;
};
 
SOPC_SKscheduler* SOPC_SKscheduler_Create(void);
 
SOPC_ReturnStatus SOPC_SKscheduler_AddTask(SOPC_SKscheduler* sko,
                                           SOPC_SKBuilder* skb,
                                           SOPC_SKProvider* skp,
                                           SOPC_SKManager* skm,
                                           uint32_t msPeriod);
 
SOPC_ReturnStatus SOPC_SKscheduler_Start(SOPC_SKscheduler* sko);
 
SOPC_ReturnStatus SOPC_SKscheduler_Stop(SOPC_SKscheduler* sko);
 
void SOPC_SKscheduler_StopAndClear(SOPC_SKscheduler* sko);
 
#endif /* SOPC_SK_SCHEDULER_H_ */