cs104_connection.h

Go to the documentation of this file.

/*
 *  Copyright 2016-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_CS104_CONNECTION_H_
#define SRC_INC_CS104_CONNECTION_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "tls_config.h"
#include "iec60870_master.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct sCS104_Connection* CS104_Connection;
 
CS104_Connection
CS104_Connection_create(const char* hostname, int tcpPort);
 
CS104_Connection
CS104_Connection_createSecure(const char* hostname, int tcpPort, TLSConfiguration tlsConfig);
 
 
void
CS104_Connection_setLocalAddress(CS104_Connection self, const char* localIpAddress, int localPort);
 
void
CS104_Connection_setAPCIParameters(CS104_Connection self, const CS104_APCIParameters parameters);
 
CS104_APCIParameters
CS104_Connection_getAPCIParameters(CS104_Connection self);
 
void
CS104_Connection_setAppLayerParameters(CS104_Connection self, const CS101_AppLayerParameters parameters);
 
CS101_AppLayerParameters
CS104_Connection_getAppLayerParameters(CS104_Connection self);
 
void
CS104_Connection_setConnectTimeout(CS104_Connection self, int millies);
 
void
CS104_Connection_connectAsync(CS104_Connection self);
 
bool
CS104_Connection_connect(CS104_Connection self);
 
void
CS104_Connection_sendStartDT(CS104_Connection self);
 
void
CS104_Connection_sendStopDT(CS104_Connection self);
 
bool
CS104_Connection_isTransmitBufferFull(CS104_Connection self);
 
bool
CS104_Connection_sendInterrogationCommand(CS104_Connection self, CS101_CauseOfTransmission cot, int ca, QualifierOfInterrogation qoi);
 
bool
CS104_Connection_sendCounterInterrogationCommand(CS104_Connection self, CS101_CauseOfTransmission cot, int ca, uint8_t qcc);
 
bool
CS104_Connection_sendReadCommand(CS104_Connection self, int ca, int ioa);
 
bool
CS104_Connection_sendClockSyncCommand(CS104_Connection self, int ca, CP56Time2a newTime);
 
bool
CS104_Connection_sendTestCommand(CS104_Connection self, int ca);
 
bool
CS104_Connection_sendTestCommandWithTimestamp(CS104_Connection self, int ca, uint16_t tsc, CP56Time2a timestamp);
 
bool
CS104_Connection_sendProcessCommand(CS104_Connection self, TypeID typeId, CS101_CauseOfTransmission cot,
        int ca, InformationObject command);
 
bool
CS104_Connection_sendProcessCommandEx(CS104_Connection self, CS101_CauseOfTransmission cot, int ca, InformationObject sc);
 
 
bool
CS104_Connection_sendASDU(CS104_Connection self, CS101_ASDU asdu);
 
void
CS104_Connection_setASDUReceivedHandler(CS104_Connection self, CS101_ASDUReceivedHandler handler, void* parameter);
 
typedef enum {
    CS104_CONNECTION_OPENED = 0,
    CS104_CONNECTION_CLOSED = 1,
    CS104_CONNECTION_STARTDT_CON_RECEIVED = 2,
    CS104_CONNECTION_STOPDT_CON_RECEIVED = 3,
    CS104_CONNECTION_FAILED = 4
} CS104_ConnectionEvent;
 
typedef void (*CS104_ConnectionHandler) (void* parameter, CS104_Connection connection, CS104_ConnectionEvent event);
 
void
CS104_Connection_setConnectionHandler(CS104_Connection self, CS104_ConnectionHandler handler, void* parameter);
 
 
void
CS104_Connection_setRawMessageHandler(CS104_Connection self, IEC60870_RawMessageHandler handler, void* parameter);
 
void
CS104_Connection_close(CS104_Connection self);
 
void
CS104_Connection_destroy(CS104_Connection self);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SRC_INC_CS104_CONNECTION_H_ */