cs104_slave.h

Go to the documentation of this file.

/*
 *  cs104_slave.h
 *
 *  Copyright 2017-2022 Michael Zillgith
 *
 *  This file is part of lib60870-C
 *
 *  lib60870-C 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.
 *
 *  lib60870-C 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 lib60870-C.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  See COPYING file for the complete license text.
 */
 
#ifndef SRC_INC_API_CS104_SLAVE_H_
#define SRC_INC_API_CS104_SLAVE_H_
 
#include "iec60870_slave.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct sCS104_Slave* CS104_Slave;
 
typedef enum {
    CS104_MODE_SINGLE_REDUNDANCY_GROUP,
    CS104_MODE_CONNECTION_IS_REDUNDANCY_GROUP,
    CS104_MODE_MULTIPLE_REDUNDANCY_GROUPS
} CS104_ServerMode;
 
typedef enum
{
    IP_ADDRESS_TYPE_IPV4,
    IP_ADDRESS_TYPE_IPV6
} eCS104_IPAddressType;
 
typedef struct sCS104_RedundancyGroup* CS104_RedundancyGroup;
 
typedef bool (*CS104_ConnectionRequestHandler) (void* parameter, const char* ipAddress);
 
typedef enum {
    CS104_CON_EVENT_CONNECTION_OPENED = 0,
    CS104_CON_EVENT_CONNECTION_CLOSED = 1,
    CS104_CON_EVENT_ACTIVATED = 2,
    CS104_CON_EVENT_DEACTIVATED = 3
} CS104_PeerConnectionEvent;
 
 
typedef void (*CS104_ConnectionEventHandler) (void* parameter, IMasterConnection connection, CS104_PeerConnectionEvent event);
 
typedef void (*CS104_SlaveRawMessageHandler) (void* parameter, IMasterConnection connection, uint8_t* msg, int msgSize, bool send);
 
 
CS104_Slave
CS104_Slave_create(int maxLowPrioQueueSize, int maxHighPrioQueueSize);
 
CS104_Slave
CS104_Slave_createSecure(int maxLowPrioQueueSize, int maxHighPrioQueueSize, TLSConfiguration tlsConfig);
 
void
CS104_Slave_addPlugin(CS104_Slave self, CS101_SlavePlugin plugin);
 
void
CS104_Slave_setLocalAddress(CS104_Slave self, const char* ipAddress);
 
void
CS104_Slave_setLocalPort(CS104_Slave self, int tcpPort);
 
int
CS104_Slave_getOpenConnections(CS104_Slave self);
 
void
CS104_Slave_setMaxOpenConnections(CS104_Slave self, int maxOpenConnections);
 
void
CS104_Slave_setServerMode(CS104_Slave self, CS104_ServerMode serverMode);
 
void
CS104_Slave_setConnectionRequestHandler(CS104_Slave self, CS104_ConnectionRequestHandler handler, void* parameter);
 
void
CS104_Slave_setConnectionEventHandler(CS104_Slave self, CS104_ConnectionEventHandler handler, void* parameter);
 
void
CS104_Slave_setInterrogationHandler(CS104_Slave self, CS101_InterrogationHandler handler, void*  parameter);
 
void
CS104_Slave_setCounterInterrogationHandler(CS104_Slave self, CS101_CounterInterrogationHandler handler, void*  parameter);
 
void
CS104_Slave_setReadHandler(CS104_Slave self, CS101_ReadHandler handler, void* parameter);
 
void
CS104_Slave_setASDUHandler(CS104_Slave self, CS101_ASDUHandler handler, void* parameter);
 
void
CS104_Slave_setClockSyncHandler(CS104_Slave self, CS101_ClockSynchronizationHandler handler, void* parameter);
 
void
CS104_Slave_setRawMessageHandler(CS104_Slave self, CS104_SlaveRawMessageHandler handler, void* parameter);
 
CS104_APCIParameters
CS104_Slave_getConnectionParameters(CS104_Slave self);
 
CS101_AppLayerParameters
CS104_Slave_getAppLayerParameters(CS104_Slave self);
 
void
CS104_Slave_start(CS104_Slave self);
 
bool
CS104_Slave_isRunning(CS104_Slave self);
 
void
CS104_Slave_stop(CS104_Slave self);
 
void
CS104_Slave_startThreadless(CS104_Slave self);
 
void
CS104_Slave_stopThreadless(CS104_Slave self);
 
void
CS104_Slave_tick(CS104_Slave self);
 
/*
 * \brief Gets the number of ASDU in the low-priority queue
 *
 * NOTE: Mode CS104_MODE_CONNECTION_IS_REDUNDANCY_GROUP is not supported by this function.
 *
 * \param redGroup the redundancy group to use or NULL for single redundancy mode
 *
 * \return the number of ASDU in the low-priority queue
 */
int
CS104_Slave_getNumberOfQueueEntries(CS104_Slave self, CS104_RedundancyGroup redGroup);
 
void
CS104_Slave_enqueueASDU(CS104_Slave self, CS101_ASDU asdu);
 
void
CS104_Slave_addRedundancyGroup(CS104_Slave self, CS104_RedundancyGroup redundancyGroup);
 
void
CS104_Slave_destroy(CS104_Slave self);
 
CS104_RedundancyGroup
CS104_RedundancyGroup_create(const char* name);
 
void
CS104_RedundancyGroup_addAllowedClient(CS104_RedundancyGroup self, const char* ipAddress);
 
void
CS104_RedundancyGroup_addAllowedClientEx(CS104_RedundancyGroup self, const uint8_t* ipAddress, eCS104_IPAddressType addressType);
 
void
CS104_RedundancyGroup_destroy(CS104_RedundancyGroup self);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SRC_INC_API_CS104_SLAVE_H_ */