Deliver network status
authorThorsten Kummermehr <thorsten.kummermehr@k2l.de>
Tue, 7 Nov 2017 19:40:23 +0000 (20:40 +0100)
committerThorsten Kummermehr <thorsten.kummermehr@k2l.de>
Tue, 7 Nov 2017 19:40:23 +0000 (20:40 +0100)
ucs2-interface/ucs_interface.h

index 9fc2475..d7a1f66 100644 (file)
@@ -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.