goose_subscriber.h

Go to the documentation of this file.

/*
 *  goose_subscriber.h
 *
 *  Copyright 2013-2021 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 GOOSE_SUBSCRIBER_H_
#define GOOSE_SUBSCRIBER_H_
 
#include "libiec61850_common_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "mms_value.h"
 
typedef enum
{
    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
} GooseParseError;
 
typedef struct sGooseSubscriber* GooseSubscriber;
 
typedef void (*GooseListener)(GooseSubscriber subscriber, void* parameter);
 
LIB61850_API GooseSubscriber
GooseSubscriber_create(char* goCbRef, MmsValue* dataSetValues);
 
LIB61850_API char*
GooseSubscriber_getGoId(GooseSubscriber self);
 
LIB61850_API char*
GooseSubscriber_getGoCbRef(GooseSubscriber self);
 
LIB61850_API char*
GooseSubscriber_getDataSet(GooseSubscriber self);
 
LIB61850_API void
GooseSubscriber_setDstMac(GooseSubscriber self, uint8_t dstMac[6]);
 
LIB61850_API void
GooseSubscriber_setAppId(GooseSubscriber self, uint16_t appId);
 
LIB61850_API bool
GooseSubscriber_isValid(GooseSubscriber self);
 
LIB61850_API GooseParseError
GooseSubscriber_getParseError(GooseSubscriber self);
 
LIB61850_API void
GooseSubscriber_destroy(GooseSubscriber self);
 
LIB61850_API void
GooseSubscriber_setListener(GooseSubscriber self, GooseListener listener, void* parameter);
 
LIB61850_API int32_t
GooseSubscriber_getAppId(GooseSubscriber self);
 
LIB61850_API void
GooseSubscriber_getSrcMac(GooseSubscriber self, uint8_t* buffer);
 
LIB61850_API void
GooseSubscriber_getDstMac(GooseSubscriber self, uint8_t* buffer);
 
LIB61850_API uint32_t
GooseSubscriber_getStNum(GooseSubscriber self);
 
LIB61850_API uint32_t
GooseSubscriber_getSqNum(GooseSubscriber self);
 
LIB61850_API bool
GooseSubscriber_isTest(GooseSubscriber self);
 
LIB61850_API uint32_t
GooseSubscriber_getConfRev(GooseSubscriber self);
 
LIB61850_API bool
GooseSubscriber_needsCommission(GooseSubscriber self);
 
LIB61850_API uint32_t
GooseSubscriber_getTimeAllowedToLive(GooseSubscriber self);
 
LIB61850_API uint64_t
GooseSubscriber_getTimestamp(GooseSubscriber self);
 
LIB61850_API MmsValue*
GooseSubscriber_getDataSetValues(GooseSubscriber self);
 
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);
#ifdef __cplusplus
}
#endif
 
 
#endif /* GOOSE_SUBSCRIBER_H_ */