goose_subscriber.h File Reference

#include "libiec61850_common_api.h"
#include "mms_value.h"

Go to the source code of this file.

Typedefs
typedef struct sGooseSubscriber *	GooseSubscriber
typedef void(*	GooseListener) (GooseSubscriber subscriber, void *parameter)
	user provided callback function that will be invoked when a GOOSE message is received. More...

Enumerations
enum	GooseParseError {   GOOSE_PARSE_ERROR_NO_ERROR = 0 , GOOSE_PARSE_ERROR_UNKNOWN_TAG , GOOSE_PARSE_ERROR_TAGDECODE , GOOSE_PARSE_ERROR_SUBLEVEL ,   GOOSE_PARSE_ERROR_OVERFLOW , GOOSE_PARSE_ERROR_UNDERFLOW , GOOSE_PARSE_ERROR_TYPE_MISMATCH , GOOSE_PARSE_ERROR_LENGTH_MISMATCH ,   GOOSE_PARSE_ERROR_INVALID_PADDING }

Functions
LIB61850_API GooseSubscriber	GooseSubscriber_create (char *goCbRef, MmsValue *dataSetValues)
	create a new GOOSE subscriber instance. More...
LIB61850_API char *	GooseSubscriber_getGoId (GooseSubscriber self)
	Get the GoId value of the received GOOSE message. More...
LIB61850_API char *	GooseSubscriber_getGoCbRef (GooseSubscriber self)
	Get the GOOSE Control Block reference value of the received GOOSE message. More...
LIB61850_API char *	GooseSubscriber_getDataSet (GooseSubscriber self)
	Get the DatSet value of the received GOOSE message. More...
LIB61850_API void	GooseSubscriber_setDstMac (GooseSubscriber self, uint8_t dstMac[6])
	set the destination mac address used by the subscriber to filter relevant messages. More...
LIB61850_API void	GooseSubscriber_setAppId (GooseSubscriber self, uint16_t appId)
	set the APPID used by the subscriber to filter relevant messages. More...
LIB61850_API bool	GooseSubscriber_isValid (GooseSubscriber self)
	Check if subscriber state is valid. More...
LIB61850_API GooseParseError	GooseSubscriber_getParseError (GooseSubscriber self)
	Get parse error in case of invalid subscriber state. More...
LIB61850_API void	GooseSubscriber_destroy (GooseSubscriber self)
	Destroy the GooseSubscriber instance. More...
LIB61850_API void	GooseSubscriber_setListener (GooseSubscriber self, GooseListener listener, void *parameter)
	set a callback function that will be invoked when a GOOSE message has been received. More...
LIB61850_API int32_t	GooseSubscriber_getAppId (GooseSubscriber self)
	Get the APPID value of the received GOOSE message. More...
LIB61850_API void	GooseSubscriber_getSrcMac (GooseSubscriber self, uint8_t *buffer)
	Get the source MAC address of the received GOOSE message. More...
LIB61850_API void	GooseSubscriber_getDstMac (GooseSubscriber self, uint8_t *buffer)
	Get the destination MAC address of the received GOOSE message. More...
LIB61850_API uint32_t	GooseSubscriber_getStNum (GooseSubscriber self)
	return the state number (stNum) of the last received GOOSE message. More...
LIB61850_API uint32_t	GooseSubscriber_getSqNum (GooseSubscriber self)
	return the sequence number (sqNum) of the last received GOOSE message. More...
LIB61850_API bool	GooseSubscriber_isTest (GooseSubscriber self)
	returns the test flag of the last received GOOSE message More...
LIB61850_API uint32_t	GooseSubscriber_getConfRev (GooseSubscriber self)
	returns the confRev value of the last received GOOSE message More...
LIB61850_API bool	GooseSubscriber_needsCommission (GooseSubscriber self)
	returns the value of the ndsCom (needs commission) flag of the last received GOOSE message. More...
LIB61850_API uint32_t	GooseSubscriber_getTimeAllowedToLive (GooseSubscriber self)
	Get the TimeAllowedToLive value of the last received message. More...
LIB61850_API uint64_t	GooseSubscriber_getTimestamp (GooseSubscriber self)
	Get the timestamp of the last received message. More...
LIB61850_API MmsValue *	GooseSubscriber_getDataSetValues (GooseSubscriber self)
	get the data set values received with the last report More...
LIB61850_API bool	GooseSubscriber_isVlanSet (GooseSubscriber self)
LIB61850_API uint16_t	GooseSubscriber_getVlanId (GooseSubscriber self)
LIB61850_API uint8_t	GooseSubscriber_getVlanPrio (GooseSubscriber self)
LIB61850_API void	GooseSubscriber_setObserver (GooseSubscriber self)
	Configure the Subscriber to listen to any received GOOSE message. More...