summaryrefslogtreecommitdiffstats
path: root/ucs2-interface/ucs_interface.h
diff options
context:
space:
mode:
authorThorsten Kummermehr <thorsten.kummermehr@k2l.de>2017-11-07 20:40:23 +0100
committerThorsten Kummermehr <thorsten.kummermehr@k2l.de>2017-11-07 20:40:23 +0100
commit8f1c8274858d02923165ae267cbda7c48498bbeb (patch)
tree445d9b5efd1cd2b95b699b07927d654958456229 /ucs2-interface/ucs_interface.h
parent1e24766a5685951f6f66f9c545a987573851dbb9 (diff)
Deliver network status
Diffstat (limited to 'ucs2-interface/ucs_interface.h')
-rw-r--r--ucs2-interface/ucs_interface.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/ucs2-interface/ucs_interface.h b/ucs2-interface/ucs_interface.h
index 9fc2475..d7a1f66 100644
--- a/ucs2-interface/ucs_interface.h
+++ b/ucs2-interface/ucs_interface.h
@@ -212,6 +212,15 @@ extern uint16_t UCSI_CB_OnGetTime(void *pTag);
*/
extern void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout);
+/**
+ * \brief Callback when ever the state of the Network has changed.
+ * \note This function must be implemented by the integrator
+ * \param pTag - Pointer given by the integrator by UCSI_Init
+ * \param isAvailable - true, if the network is operable. false, network is down. No message or stream can be sent or received.
+ * \param packetBandwidth - The amount of bytes per frame reserved for the Ethernet channel. Must match to the given packetBw value passed to UCSI_NewConfig.
+ * \param amountOfNodes - The amount of network devices found in the ring.
+ */
+extern void UCSI_CB_OnNetworkState(void *pTag, bool isAvailable, uint16_t packetBandwidth, uint8_t amountOfNodes);
/**
* \brief Callback when ever an UNICENS forms a human readable message.