sopc_sub_scheduler.h File Reference

#include "sopc_pubsub_conf.h"
#include "sopc_sub_target_variable.h"

Go to the source code of this file.

Typedefs
typedef enum SOPC_PubSubState	SOPC_PubSubState
typedef void	SOPC_SubscriberStateChanged_Func(const SOPC_Conf_PublisherId *pubId, uint16_t groupId, uint16_t writerId, SOPC_PubSubState state)
typedef void	SOPC_SubscriberDataSetMessageSNGap_Func(SOPC_Conf_PublisherId pubId, uint16_t groupId, uint16_t writerId, uint16_t prevSN, uint16_t receivedSN)
	Callback to notify gaps in received DataSetMessage sequence number. DataSetMessage is identified by tuple [pubId, groupId, writerId] describe below.

Enumerations
enum	SOPC_PubSubState { SOPC_PubSubState_Disabled = 0 , SOPC_PubSubState_Paused = 1 , SOPC_PubSubState_Operational = 2 , SOPC_PubSubState_Error = 3 }

Functions
bool	SOPC_SubScheduler_Start (SOPC_PubSubConfiguration *config, SOPC_SubTargetVariableConfig *targetConfig, SOPC_SubscriberStateChanged_Func *pStateChangedCb, SOPC_SubscriberDataSetMessageSNGap_Func sdmSnGapCb, SOPC_PubSub_OnFatalError *pSubDisconnectedCb, int threadPriority)
void	SOPC_SubScheduler_Stop (void)

Typedef Documentation

SOPC_PubSubState

typedef enum SOPC_PubSubState SOPC_PubSubState

SOPC_SubscriberStateChanged_Func

typedef void SOPC_SubscriberStateChanged_Func(const SOPC_Conf_PublisherId *pubId, uint16_t groupId, uint16_t writerId, SOPC_PubSubState state)

SOPC_SubscriberDataSetMessageSNGap_Func

typedef void SOPC_SubscriberDataSetMessageSNGap_Func(SOPC_Conf_PublisherId pubId, uint16_t groupId, uint16_t writerId, uint16_t prevSN, uint16_t receivedSN)

Callback to notify gaps in received DataSetMessage sequence number. DataSetMessage is identified by tuple [pubId, groupId, writerId] describe below.

Parameters

pubId	Publisher Id of the networkMessage
groupId	WriterGroupId to filter dataSetMessage
writerId	dataSetWriterId to filter dataSetMessage
prevSN	previous DataSetMessage sequence number received
receivedSN	current DataSetMessage sequence number received

Enumeration Type Documentation

SOPC_PubSubState

enum SOPC_PubSubState

Enumerator
SOPC_PubSubState_Disabled
SOPC_PubSubState_Paused
SOPC_PubSubState_Operational
SOPC_PubSubState_Error

Function Documentation

SOPC_SubScheduler_Start()

bool SOPC_SubScheduler_Start	(	SOPC_PubSubConfiguration *	config,
		SOPC_SubTargetVariableConfig *	targetConfig,
		SOPC_SubscriberStateChanged_Func *	pStateChangedCb,
		SOPC_SubscriberDataSetMessageSNGap_Func	sdmSnGapCb,
		SOPC_PubSub_OnFatalError *	pSubDisconnectedCb,
		int	threadPriority )

SOPC_SubScheduler_Stop()

void SOPC_SubScheduler_Stop

(

void

)