sopc_pub_source_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_PUB_SOURCE_VARIABLE_H_
#define SOPC_PUB_SOURCE_VARIABLE_H_
 
#include "sopc_event_handler.h"
#include "sopc_mutexes.h"
#include "sopc_pubsub_conf.h"
#include "sopc_types.h"
 
// TODO: this structure is taken from the sample/pubsub_server,
//  where it is used to handle asynchronous OPC UA local read request.
//  Either put it back there or document it properly.
// Pubscheduler get var request
typedef struct SOPC_PubSheduler_GetVariableRequestContext
{
    SOPC_DataValue* ldv;             // Data values response
    SOPC_EventHandler* eventHandler; // Event handler where to send result
    int32_t NoOfNodesToRead;         // Size of ldv
    uintptr_t msgCtxt;               // context of request
    SOPC_Condition cond;
    SOPC_Mutex mut;
} SOPC_PubSheduler_GetVariableRequestContext;
 
typedef struct SOPC_PubSourceVariableConfig SOPC_PubSourceVariableConfig;
 
typedef struct SOPC_SourceVariableCtx SOPC_SourceVariableCtx;
 
typedef SOPC_DataValue* SOPC_GetSourceVariables_Func(const OpcUa_ReadValueId* nodesToRead, const int32_t nbValues);
 
SOPC_PubSourceVariableConfig* SOPC_PubSourceVariableConfig_Create(SOPC_GetSourceVariables_Func* callback);
 
void SOPC_PubSourceVariableConfig_Delete(SOPC_PubSourceVariableConfig* sourceConfig);
 
SOPC_DataValue* SOPC_PubSourceVariable_GetVariables(const SOPC_PubSourceVariableConfig* sourceConfig,
                                                    const SOPC_SourceVariableCtx* sourceVariable);
 
SOPC_SourceVariableCtx* SOPC_PubSourceVariable_SourceVariablesCtx_Create(const SOPC_PublishedDataSet* pubDataset);
 
/* Delete SourceVariableCtx */
void SOPC_PubSourceVariable_SourceVariableCtx_Delete(SOPC_SourceVariableCtx** pubSourceVariable);
 
#endif /* SOPC_PUB_SOURCE_VARIABLE_H_ */