You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
libiec61850/src/mms/inc/iso_server.h

151 lines
3.3 KiB
C

/*
* iso_server.h
*
* Copyright 2013 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 ISO_SERVER_H_
#define ISO_SERVER_H_
#include "byte_buffer.h"
#include "iso_connection_parameters.h"
#ifdef __cplusplus
extern "C" {
#endif
/** \addtogroup mms_server_api_group
* @{
*/
typedef enum
{
ISO_SVR_STATE_IDLE,
ISO_SVR_STATE_RUNNING,
ISO_SVR_STATE_STOPPED,
ISO_SVR_STATE_ERROR
} IsoServerState;
typedef struct sIsoServer* IsoServer;
typedef enum
{
ISO_CONNECTION_OPENED,
ISO_CONNECTION_CLOSED
} IsoConnectionIndication;
typedef struct sIsoConnection* IsoConnection;
typedef struct sIsoServerCallbacks
{
void
(*clientConnected)(IsoConnection connection);
} IsoServerCallbacks;
typedef void
(*ConnectionIndicationHandler)(IsoConnectionIndication indication,
void* parameter, IsoConnection connection);
typedef void
(*MessageReceivedHandler)(void* parameter, ByteBuffer* message, ByteBuffer* response);
char*
IsoConnection_getPeerAddress(IsoConnection self);
void
IsoConnection_close(IsoConnection self);
void
IsoConnection_installListener(IsoConnection self, MessageReceivedHandler handler,
void* parameter);
void*
IsoConnection_getSecurityToken(IsoConnection self);
/**
* \brief send a message over an ISO connection
*
* \param handlerMode specifies if this function is used in the context of the connection handling thread
* (handlerMode)
*/
void
IsoConnection_sendMessage(IsoConnection self, ByteBuffer* message, bool handlerMode);
IsoServer
IsoServer_create(void);
void
IsoServer_setTcpPort(IsoServer self, int port);
void
IsoServer_setLocalIpAddress(IsoServer self, char* ipAddress);
IsoServerState
IsoServer_getState(IsoServer self);
void
IsoServer_setConnectionHandler(IsoServer self, ConnectionIndicationHandler handler,
void* parameter);
void
IsoServer_setAuthenticator(IsoServer self, AcseAuthenticator authenticator, void* authenticatorParameter);
AcseAuthenticator
IsoServer_getAuthenticator(IsoServer self);
void*
IsoServer_getAuthenticatorParameter(IsoServer self);
void
IsoServer_startListening(IsoServer self);
void
IsoServer_stopListening(IsoServer self);
void
IsoServer_startListeningThreadless(IsoServer self);
/**
* for non-threaded operation
*/
void
IsoServer_processIncomingMessages(IsoServer self);
int
IsoServer_waitReady(IsoServer self, unsigned int timeoutMs);
void
IsoServer_stopListeningThreadless(IsoServer self);
void
IsoServer_closeConnection(IsoServer self, IsoConnection isoConnection);
void
IsoServer_destroy(IsoServer self);
#ifdef __cplusplus
}
#endif
/**@}*/
#endif /* ISO_SERVER_H_ */