From ebe82435e8b4f18e6393a3dda7a93709dc333059 Mon Sep 17 00:00:00 2001 From: Michael Zillgith Date: Thu, 5 Mar 2015 11:29:40 +0100 Subject: [PATCH] - added documentation for GOOSE receiver --- .../simpleIO_direct_control.icd | 3 +- .../simpleIO_direct_control_goose.icd | 9 +++++ src/doxygen.config | 3 +- src/goose/goose_receiver.c | 6 --- src/goose/goose_receiver.h | 39 ++++++++++++++++--- src/goose/goose_subscriber.h | 2 +- 6 files changed, 48 insertions(+), 14 deletions(-) diff --git a/examples/server_example3/simpleIO_direct_control.icd b/examples/server_example3/simpleIO_direct_control.icd index aae342d..aeb779a 100644 --- a/examples/server_example3/simpleIO_direct_control.icd +++ b/examples/server_example3/simpleIO_direct_control.icd @@ -39,6 +39,7 @@ + @@ -53,7 +54,7 @@ - + diff --git a/examples/server_example_goose/simpleIO_direct_control_goose.icd b/examples/server_example_goose/simpleIO_direct_control_goose.icd index 3efbf70..4adbf3f 100644 --- a/examples/server_example_goose/simpleIO_direct_control_goose.icd +++ b/examples/server_example_goose/simpleIO_direct_control_goose.icd @@ -61,12 +61,21 @@ + + + + + + + + + diff --git a/src/doxygen.config b/src/doxygen.config index 7ffa8cf..0d8fbf0 100644 --- a/src/doxygen.config +++ b/src/doxygen.config @@ -18,7 +18,7 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "libIEC61850" -PROJECT_NUMBER = 0.8.5 +PROJECT_NUMBER = 0.8.6 PROJECT_BRIEF = "Open-source IEC 61850 MMS/GOOSE server and client library" @@ -218,6 +218,7 @@ INPUT += "iec61850/inc/iec61850_dynamic_model.h" INPUT += "iec61850/inc/iec61850_config_file_parser.h" INPUT += "iec61850/inc/iec61850_cdc.h" INPUT += "goose/goose_subscriber.h" +INPUT += "goose/goose_receiver.h" INPUT += "mms/inc/mms_device_model.h" INPUT += "mms/inc/mms_types.h" INPUT += "mms/inc/mms_common.h" diff --git a/src/goose/goose_receiver.c b/src/goose/goose_receiver.c index 0a6c958..91a435c 100644 --- a/src/goose/goose_receiver.c +++ b/src/goose/goose_receiver.c @@ -93,12 +93,6 @@ GooseReceiver_setInterfaceId(GooseReceiver self, const char* interfaceId) self->interfaceId = copyString(interfaceId); } - -void -GooseReceiver_setBackupListener(GooseReceiver self) -{ -} - static void createNewStringFromBufferElement(MmsValue* value, uint8_t* bufferSrc, int elementLength) { diff --git a/src/goose/goose_receiver.h b/src/goose/goose_receiver.h index 4fa6edb..b313f2b 100644 --- a/src/goose/goose_receiver.h +++ b/src/goose/goose_receiver.h @@ -26,11 +26,31 @@ #include +/** + * \addtogroup goose_api_group + */ +/**@{*/ + + typedef struct sGooseReceiver* GooseReceiver; +/** + * \brief Create a new receiver instance + * + * A GooseReceiver instance is used to handle all GOOSE messages received on a specific + * network interface. + * + * \return the new GooseReceiver instance + */ GooseReceiver GooseReceiver_create(void); +/** + * \brief sets the interface for the GOOSE receiver + * + * \param self the GooseReceiver instance + * \param interfaceId + */ void GooseReceiver_setInterfaceId(GooseReceiver self, const char* interfaceId); @@ -58,14 +78,21 @@ GooseReceiver_addSubscriber(GooseReceiver self, GooseSubscriber subscriber); void GooseReceiver_removeSubscriber(GooseReceiver self, GooseSubscriber subscriber); -// call backup listener if message is not handled by a subscriber -void -GooseReceiver_setBackupListener(GooseReceiver self); - -// start GOOSE receiver in a separate thread +/** + * \brief start the GOOSE receiver in a separate thread + * + * \param self the GooseReceiver instance + */ void GooseReceiver_start(GooseReceiver self); +/** + * \brief stop the GOOSE receiver running in a speparate thread + * + * This function is used to stop the receiver thread started with GooseReceiver_start + * + * \param self the GooseReceiver instance + */ void GooseReceiver_stop(GooseReceiver self); @@ -93,4 +120,6 @@ GooseReceiver_stopThreadless(GooseReceiver self); bool GooseReceiver_tick(GooseReceiver self); +/**@}*/ + #endif /* GOOSE_RECEIVER_H_ */ diff --git a/src/goose/goose_subscriber.h b/src/goose/goose_subscriber.h index f9f0974..db35050 100644 --- a/src/goose/goose_subscriber.h +++ b/src/goose/goose_subscriber.h @@ -61,7 +61,7 @@ typedef void (*GooseListener)(GooseSubscriber subscriber, void* parameter); * IedConnection_getDataSet() method before. * * If NULL is given as dataSetValues it will be created the first time when a appropriate GOOSE message - * is recevied. + * is received. * * \param goCbRef a string containing the object reference of the GOOSE Control Block (GoCB) in MMS notation the * GOOSE publisher uses.