sopc_pub_scheduler.h File Reference

#include "sopc_pub_source_variable.h"
#include "sopc_pubsub_conf.h"

Go to the source code of this file.

Functions
bool	SOPC_PubScheduler_Start (SOPC_PubSubConfiguration *config, SOPC_PubSourceVariableConfig *sourceConfig, int threadPriority)
	Starts the Publisher scheduler using the PubSub configuration data and the source of data information.
bool	SOPC_PubScheduler_AcyclicSend (uint16_t writerGroupId)
	Launch sending process in acyclic mode. Content of the message can be modified in callback SOPC_GetSourceVariables_Func set in function SOPC_PubSourceVariableConfig_Create. To select the content to be sent writerGroupId shall match the WriterGroup Id of dataset set in configuration.
void	SOPC_PubScheduler_Stop (void)

Function Documentation

SOPC_PubScheduler_Start()

bool SOPC_PubScheduler_Start	(	SOPC_PubSubConfiguration *	config,
		SOPC_PubSourceVariableConfig *	sourceConfig,
		int	threadPriority )

Starts the Publisher scheduler using the PubSub configuration data and the source of data information.

Parameters

config	The PubSub configuration to be used to start the Publisher
sourceConfig	The source configured to retrieve up to date data referenced in config
threadPriority	Under linux, the publisher wakes up more regularly when the thread is created with a higher priority, but this requires administrative rights. This value must be 0 (thread created with usual priority) or 1 to 99 (thread created with FIFO scheduling policy requiring administrative rights)

SOPC_PubScheduler_AcyclicSend()

bool SOPC_PubScheduler_AcyclicSend

(

uint16_t

writerGroupId

)

Launch sending process in acyclic mode. Content of the message can be modified in callback SOPC_GetSourceVariables_Func set in function SOPC_PubSourceVariableConfig_Create. To select the content to be sent writerGroupId shall match the WriterGroup Id of dataset set in configuration.

Parameters

writerGroupId

Id of the writer group to send

Returns

true if succeed to match a writer group to send and send it

false no writerGroupId match with configuration don't send anything

SOPC_PubScheduler_Stop()

void SOPC_PubScheduler_Stop

(

void

)