libiec61850/src/iec61850/inc_private/logging.h

/*
 *  logging.h
 *
 *  Copyright 2016 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 LIBIEC61850_SRC_IEC61850_INC_PRIVATE_LOGGING_H_
#define LIBIEC61850_SRC_IEC61850_INC_PRIVATE_LOGGING_H_

typedef struct {
    char* name;
    LogicalNode* parentLN;

    bool locked;

    LogStorage logStorage;

    uint64_t newEntryId;
    uint64_t newEntryTime;

    uint64_t oldEntryId;
    uint64_t oldEntryTime;

} LogInstance;

typedef struct {
    char* name;
    LogControlBlock* logControlBlock;
    MmsMapping* mmsMapping;

    DataSet* dataSet;
    char* dataSetRef;
    bool isDynamicDataSet;

    LogicalNode* logicalNode;
    MmsDomain* domain;

    MmsValue* mmsValue;
    MmsVariableSpecification* mmsType;

    MmsValue* oldEntr;
    MmsValue* oldEntrTm;
    MmsValue* newEntr;
    MmsValue* newEntrTm;

    LogInstance* logInstance;

    bool enabled;

    uint64_t nextIntegrityScan;

    int triggerOps;
    uint32_t intgPd;

} LogControl;


LIB61850_INTERNAL LogInstance*
LogInstance_create(LogicalNode* parentLN, const char* name);

LIB61850_INTERNAL void
LogInstance_setLogStorage(LogInstance* self, LogStorage logStorage);

LIB61850_INTERNAL void
LogInstance_logSingleData(LogInstance* self, const char* dataRef, MmsValue* value, uint8_t flag);

LIB61850_INTERNAL uint64_t
LogInstance_logEntryStart(LogInstance* self);

LIB61850_INTERNAL void
LogInstance_logEntryData(LogInstance* self, uint64_t entryID, const char* dataRef, MmsValue* value, uint8_t flag);

LIB61850_INTERNAL void
LogInstance_logEntryFinished(LogInstance* self, uint64_t entryID);

LIB61850_INTERNAL void
LogInstance_destroy(LogInstance* self);

LIB61850_INTERNAL LogControl*
LogControl_create(LogicalNode* parentLN, MmsMapping* mmsMapping);

LIB61850_INTERNAL void
LogControl_setLog(LogControl* self, LogInstance* logInstance);

LIB61850_INTERNAL void
LogControl_destroy(LogControl* self);

LIB61850_INTERNAL void
LogControl_setLogStorage(LogControl* self, LogStorage logStorage);

LIB61850_INTERNAL MmsVariableSpecification*
Logging_createLCBs(MmsMapping* self, MmsDomain* domain, LogicalNode* logicalNode,
        int lcbCount);

LIB61850_INTERNAL void
Logging_processIntegrityLogs(MmsMapping* self, uint64_t currentTimeInMs);

LIB61850_INTERNAL MmsValue*
LIBIEC61850_LOG_SVC_readAccessControlBlock(MmsMapping* self, MmsDomain* domain, char* variableIdOrig);

LIB61850_INTERNAL MmsDataAccessError
LIBIEC61850_LOG_SVC_writeAccessLogControlBlock(MmsMapping* self, MmsDomain* domain, char* variableIdOrig,
        MmsValue* value, MmsServerConnection connection);

#endif /* LIBIEC61850_SRC_IEC61850_INC_PRIVATE_LOGGING_H_ */