sopc_sub_target_variable.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_SUB_TARGET_VARIABLE_H_
#define SOPC_SUB_TARGET_VARIABLE_H_
 
#include "sopc_dataset_ll_layer.h"
#include "sopc_pubsub_conf.h"
#include "sopc_sub_target_variable.h"
#include "sopc_types.h"
 
/* Configuration to provide as target variable config when starting subscriber */
typedef struct _SOPC_SubTargetVariableConfig SOPC_SubTargetVariableConfig;
 
typedef struct SOPC_TargetVariableCtx SOPC_TargetVariableCtx;
 
typedef bool SOPC_SetTargetVariables_Func(const OpcUa_WriteValue* nodesToWrite, const int32_t nbValues);
 
/* If callback NULL, creation succeeds and SetVariables will only check input parameters on call */
SOPC_SubTargetVariableConfig* SOPC_SubTargetVariableConfig_Create(SOPC_SetTargetVariables_Func* callback);
 
void SOPC_SubTargetVariableConfig_Delete(SOPC_SubTargetVariableConfig* targetConfig);
 
/* Function used by subscriber scheduler to set target variables */
bool SOPC_SubTargetVariable_SetVariables(SOPC_SubTargetVariableConfig* targetConfig,
                                         SOPC_TargetVariableCtx* targetVariable,
                                         const SOPC_DataSetReader* reader,
                                         SOPC_Dataset_LL_DataSetMessage* dsm);
 
SOPC_TargetVariableCtx* SOPC_SubTargetVariable_TargetVariablesCtx_Create(const SOPC_DataSetReader* reader);
 
/* Delete TargetVariableCtx */
void SOPC_SubTargetVariable_TargetVariableCtx_Delete(SOPC_TargetVariableCtx** subTargetVariable);
 
#endif /* SOPC_SUB_TARGET_VARIABLE_H_ */