sv_subscriber.h

Go to the documentation of this file.

/*
 *  sv_subscriber.h
 *
 *  Copyright 2015-2018 Michael Zillgith
 *
 *  This file is part of libIEC61850.
 *
 *  libIEC61850 is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  libIEC61850 is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with libIEC61850.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  See COPYING file for the complete license text.
 */
 
#ifndef SAMPLED_VALUES_SV_SUBSCRIBER_H_
#define SAMPLED_VALUES_SV_SUBSCRIBER_H_
 
#include "libiec61850_common_api.h"
#include "iec61850_common.h"
#include "hal_ethernet.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct sSVSubscriber_ASDU* SVSubscriber_ASDU;
 
typedef struct sSVSubscriber* SVSubscriber;
 
typedef void (*SVUpdateListener)(SVSubscriber subscriber, void* parameter, SVSubscriber_ASDU asdu);
 
typedef struct sSVReceiver* SVReceiver;
 
LIB61850_API SVReceiver
SVReceiver_create(void);
 
LIB61850_API void
SVReceiver_disableDestAddrCheck(SVReceiver self);
 
LIB61850_API void
SVReceiver_enableDestAddrCheck(SVReceiver self);
 
LIB61850_API void
SVReceiver_setInterfaceId(SVReceiver self, const char* interfaceId);
 
LIB61850_API void
SVReceiver_addSubscriber(SVReceiver self, SVSubscriber subscriber);
 
LIB61850_API void
SVReceiver_removeSubscriber(SVReceiver self, SVSubscriber subscriber);
 
LIB61850_API void
SVReceiver_start(SVReceiver self);
 
LIB61850_API void
SVReceiver_stop(SVReceiver self);
 
LIB61850_API bool
SVReceiver_isRunning(SVReceiver self);
 
LIB61850_API void
SVReceiver_destroy(SVReceiver self);
 
/***************************************
 * Functions for non-threaded operation
 ***************************************/
 
LIB61850_API EthernetSocket
SVReceiver_startThreadless(SVReceiver self);
 
LIB61850_API void
SVReceiver_stopThreadless(SVReceiver self);
 
LIB61850_API bool
SVReceiver_tick(SVReceiver self);
 
/*
 * \brief Create a new SV subscriber instance
 *
 * \param ethAddr optional destination address (NULL to not specify the destination address)
 * \param appID the APP-ID to identify matching SV messages
 *
 * \return the new subscriber instance
 */
 
LIB61850_API SVSubscriber
SVSubscriber_create(const uint8_t* ethAddr, uint16_t appID);
 
LIB61850_API void
SVSubscriber_setListener(SVSubscriber self,  SVUpdateListener listener, void* parameter);
 
LIB61850_API void
SVSubscriber_destroy(SVSubscriber self);
 
/*************************************************************************
 * SVSubscriber_ASDU object methods
 **************************************************************************/
 
LIB61850_API uint16_t
SVSubscriber_ASDU_getSmpCnt(SVSubscriber_ASDU self);
 
LIB61850_API const char*
SVSubscriber_ASDU_getSvId(SVSubscriber_ASDU self);
 
LIB61850_API const char*
SVSubscriber_ASDU_getDatSet(SVSubscriber_ASDU self);
 
LIB61850_API uint32_t
SVSubscriber_ASDU_getConfRev(SVSubscriber_ASDU self);
 
LIB61850_API uint8_t
SVSubscriber_ASDU_getSmpMod(SVSubscriber_ASDU self);
 
LIB61850_API uint16_t
SVSubscriber_ASDU_getSmpRate(SVSubscriber_ASDU self);
 
LIB61850_API bool
SVSubscriber_ASDU_hasDatSet(SVSubscriber_ASDU self);
 
LIB61850_API bool
SVSubscriber_ASDU_hasRefrTm(SVSubscriber_ASDU self);
 
LIB61850_API bool
SVSubscriber_ASDU_hasSmpMod(SVSubscriber_ASDU self);
 
LIB61850_API bool
SVSubscriber_ASDU_hasSmpRate(SVSubscriber_ASDU self);
 
LIB61850_API uint64_t
SVSubscriber_ASDU_getRefrTmAsMs(SVSubscriber_ASDU self);
 
LIB61850_API nsSinceEpoch
SVSubscriber_ASDU_getRefrTmAsNs(SVSubscriber_ASDU self);
 
LIB61850_API int8_t
SVSubscriber_ASDU_getINT8(SVSubscriber_ASDU self, int index);
 
LIB61850_API int16_t
SVSubscriber_ASDU_getINT16(SVSubscriber_ASDU self, int index);
 
LIB61850_API int32_t
SVSubscriber_ASDU_getINT32(SVSubscriber_ASDU self, int index);
 
LIB61850_API int64_t
SVSubscriber_ASDU_getINT64(SVSubscriber_ASDU self, int index);
 
LIB61850_API uint8_t
SVSubscriber_ASDU_getINT8U(SVSubscriber_ASDU self, int index);
 
LIB61850_API uint16_t
SVSubscriber_ASDU_getINT16U(SVSubscriber_ASDU self, int index);
 
LIB61850_API uint32_t
SVSubscriber_ASDU_getINT32U(SVSubscriber_ASDU self, int index);
 
LIB61850_API uint64_t
SVSubscriber_ASDU_getINT64U(SVSubscriber_ASDU self, int index);
 
LIB61850_API float
SVSubscriber_ASDU_getFLOAT32(SVSubscriber_ASDU self, int index);
 
LIB61850_API double
SVSubscriber_ASDU_getFLOAT64(SVSubscriber_ASDU self, int index);
 
LIB61850_API Timestamp
SVSubscriber_ASDU_getTimestamp(SVSubscriber_ASDU self, int index);
 
LIB61850_API Quality
SVSubscriber_ASDU_getQuality(SVSubscriber_ASDU self, int index);
 
LIB61850_API int
SVSubscriber_ASDU_getDataSize(SVSubscriber_ASDU self);
 
uint8_t
SVSubscriber_ASDU_getSmpSynch(SVSubscriber_ASDU self);
 
#ifndef DEPRECATED
#if defined(__GNUC__) || defined(__clang__)
  #define DEPRECATED __attribute__((deprecated))
#else
  #define DEPRECATED
#endif
#endif
 
typedef struct sSVSubscriberASDU* SVClientASDU;
 
LIB61850_API DEPRECATED uint16_t
SVClientASDU_getSmpCnt(SVSubscriber_ASDU self);
 
LIB61850_API DEPRECATED const char*
SVClientASDU_getSvId(SVSubscriber_ASDU self);
 
LIB61850_API DEPRECATED uint32_t
SVClientASDU_getConfRev(SVSubscriber_ASDU self);
 
LIB61850_API DEPRECATED bool
SVClientASDU_hasRefrTm(SVSubscriber_ASDU self);
 
LIB61850_API DEPRECATED uint64_t
SVClientASDU_getRefrTmAsMs(SVSubscriber_ASDU self);
 
LIB61850_API DEPRECATED int8_t
SVClientASDU_getINT8(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED int16_t
SVClientASDU_getINT16(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED int32_t
SVClientASDU_getINT32(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED int64_t
SVClientASDU_getINT64(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED uint8_t
SVClientASDU_getINT8U(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED uint16_t
SVClientASDU_getINT16U(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED uint32_t
SVClientASDU_getINT32U(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED uint64_t
SVClientASDU_getINT64U(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED float
SVClientASDU_getFLOAT32(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED double
SVClientASDU_getFLOAT64(SVSubscriber_ASDU self, int index);
 
LIB61850_API DEPRECATED int
SVClientASDU_getDataSize(SVSubscriber_ASDU self);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAMPLED_VALUES_SV_SUBSCRIBER_ */