Improve the network state machines.

DGIdGateway/DGIdGateway.cpp

@@ -363,6 +363,8 @@ int CDGIdGateway::run()
 
 	LogMessage("Starting DGIdGateway-%s", VERSION);
 
+	DGID_STATUS state = DS_NOTLINKED;
+
 	for (;;) {
 		unsigned char buffer[200U];
 		memset(buffer, 0U, 200U);
@@ -394,6 +396,7 @@ int CDGIdGateway::run()
 						std::string desc = dgIdNetwork[dgId]->getDesc(dgId);
 						LogDebug("DG-ID set to %u (%s) via RF", dgId, desc.c_str());
 						currentDGId = dgId;
+						state = DS_NOTLINKED;
 					}
 
 					if (m_gps != NULL)
@@ -444,6 +447,7 @@ int CDGIdGateway::run()
 								std::string desc = dgIdNetwork[i]->getDesc(i);
 								LogDebug("DG-ID set to %u (%s) via Network", i, desc.c_str());
 								currentDGId = i;
+								state = DS_LINKED;
 							}
 						}
 					}
@@ -474,8 +478,19 @@ int CDGIdGateway::run()
 
 			LogDebug("DG-ID set to 0 (None) via timeout");
 
+			state = DS_NOTLINKED;
 			currentDGId = 0U;
 			inactivityTimer.stop();
+			sendPips(2U);
+		}
+
+		if (dgIdNetwork[currentDGId] != NULL) {
+			DGID_STATUS netState = dgIdNetwork[currentDGId]->getStatus();
+			if (state != DS_LINKED && netState == DS_LINKED)
+				sendPips(1U);
+			else if (state == DS_LINKED && netState != DS_LINKED)
+				sendPips(3U);
+			state = netState;
 		}
 
 		if (ms < 5U)
@@ -602,3 +617,7 @@ std::string CDGIdGateway::calculateLocator()
 	return locator;
 }
 
+void CDGIdGateway::sendPips(unsigned int n)
+{
+
+}

DGIdGateway/DGIdGateway.h

@@ -42,6 +42,7 @@ private:
 
 	std::string calculateLocator();
 	void createGPS();
+	void sendPips(unsigned int n);
 };
 
 #endif

DGIdGateway/DGIdNetwork.h

@@ -21,6 +21,13 @@
 
 #include <string>
 
+enum DGID_STATUS {
+	DS_NOTOPEN,
+	DS_NOTLINKED,
+	DS_LINKING,
+	DS_LINKED
+};
+
 class CDGIdNetwork {
 public:
 	virtual ~CDGIdNetwork() = 0;
@@ -31,6 +38,8 @@ public:
 
 	virtual void link() = 0;
 
+	virtual DGID_STATUS getStatus() = 0;
+
 	virtual void write(unsigned int dgId, const unsigned char* data) = 0;
 
 	virtual unsigned int read(unsigned int dgid, unsigned char* data) = 0;

DGIdGateway/FCSNetwork.cpp

@@ -44,7 +44,7 @@ m_buffer(1000U, "FCS Network Buffer"),
 m_n(0U),
 m_pingTimer(1000U, 0U, 800U),
 m_resetTimer(1000U, 1U),
-m_state(FCS_UNLINKED)
+m_state(DS_NOTOPEN)
 {
 	m_info = new unsigned char[100U];
 	::sprintf((char*)m_info, "%9u%9u%-6.6s%-12.12s%7u", rxFrequency, txFrequency, locator.c_str(), FCS_VERSION, id);
@@ -86,19 +86,32 @@ bool CFCSNetwork::open()
 {
 	if (m_addrLen == 0U) {
 		LogError("Unable to resolve the address of %s", m_reflector.c_str());
+		m_state = DS_NOTOPEN;
 		return false;
 	}
 
 	LogMessage("Opening FCS network connection");
 
-	return m_socket.open(m_addr);
+	bool ret = m_socket.open(m_addr);
+	if (!ret) {
+		m_state = DS_NOTOPEN;
+		return false;
+	} else {
+		m_state = DS_NOTLINKED;
+		return true;
+	}
+}
+
+DGID_STATUS CFCSNetwork::getStatus()
+{
+	return m_state;
 }
 
 void CFCSNetwork::write(unsigned int dgid, const unsigned char* data)
 {
 	assert(data != NULL);
 
-	if (m_state != FCS_LINKED)
+	if (m_state != DS_LINKED)
 		return;
 
 	unsigned char buffer[130U];
@@ -115,10 +128,10 @@ void CFCSNetwork::write(unsigned int dgid, const unsigned char* data)
 
 void CFCSNetwork::link()
 {
-	if (m_state == FCS_LINKING || m_state == FCS_LINKED)
+	if (m_state != DS_NOTLINKED)
 		return;
 
-	m_state = FCS_LINKING;
+	m_state = DS_LINKING;
 
 	m_pingTimer.start();
 
@@ -127,14 +140,21 @@ void CFCSNetwork::link()
 
 void CFCSNetwork::unlink()
 {
-	if (m_state != FCS_LINKED)
+	if (m_state != DS_LINKED)
 		return;
 
 	m_socket.write((unsigned char*)"CLOSE      ", 11U, m_addr, m_addrLen);
+
+	m_pingTimer.stop();
+
+	m_state = DS_NOTLINKED;
 }
 
 void CFCSNetwork::clock(unsigned int ms)
 {
+	if (m_state == DS_NOTOPEN)
+		return;
+
 	m_pingTimer.clock(ms);
 	if (m_pingTimer.isRunning() && m_pingTimer.hasExpired()) {
 		writePing();
@@ -155,7 +175,7 @@ void CFCSNetwork::clock(unsigned int ms)
 	if (length <= 0)
 		return;
 
-	if (m_state == FCS_UNLINKED)
+	if (m_state == DS_NOTLINKED)
 		return;
 
 	if (!CUDPSocket::match(addr, m_addr))
@@ -165,16 +185,16 @@ void CFCSNetwork::clock(unsigned int ms)
 		CUtils::dump(1U, "FCS Network Data Received", buffer, length);
 
 	if (length == 7) {
-		if (m_state == FCS_LINKING)
+		if (m_state == DS_LINKING)
 			LogMessage("Linked to %s", m_print.c_str());
-		m_state = FCS_LINKED;
+		m_state = DS_LINKED;
 		writeInfo();
 		writeOptions(m_print);
 	}
 
-	if (length == 10 && m_state == FCS_LINKING) {
+	if (length == 10 && m_state == DS_LINKING) {
 		LogMessage("Linked to %s", m_print.c_str());
-		m_state = FCS_LINKED;
+		m_state = DS_LINKED;
 		writeInfo();
 		writeOptions(m_print);
 	}
@@ -229,11 +249,13 @@ void CFCSNetwork::close()
 	m_socket.close();
 
 	LogMessage("Closing FCS network connection");
+
+	m_state = DS_NOTOPEN;
 }
 
 void CFCSNetwork::writeInfo()
 {
-	if (m_state != FCS_LINKED)
+	if (m_state != DS_LINKED)
 		return;
 
 	if (m_debug)
@@ -244,7 +266,7 @@ void CFCSNetwork::writeInfo()
 
 void CFCSNetwork::writePing()
 {
-	if (m_state == FCS_UNLINKED)
+	if (m_state != DS_LINKING && m_state != DS_LINKED)
 		return;
 
 	if (m_debug)
@@ -255,7 +277,7 @@ void CFCSNetwork::writePing()
 
 void CFCSNetwork::writeOptions(const std::string& reflector)
 {
-	if (m_state != FCS_LINKED)
+	if (m_state != DS_LINKED)
 		return;
 
 	if (m_opt.size() < 1)
@@ -270,4 +292,3 @@ void CFCSNetwork::writeOptions(const std::string& reflector)
 
 	m_socket.write(m_options, 50U, m_addr, m_addrLen);
 }
-

DGIdGateway/FCSNetwork.h

@@ -28,12 +28,6 @@
 #include <cstdint>
 #include <string>
 
-enum FCS_STATE {
-	FCS_UNLINKED,
-	FCS_LINKING,
-	FCS_LINKED
-};
-
 class CFCSNetwork : public CDGIdNetwork {
 public:
 	CFCSNetwork(const std::string& reflector, unsigned int port, const std::string& callsign, unsigned int rxFrequency, unsigned int txFrequency, const std::string& locator, unsigned int id, const std::string& options, bool debug);
@@ -43,6 +37,8 @@ public:
 
 	virtual bool open();
 
+	virtual DGID_STATUS getStatus();
+
 	virtual void link();
 
 	virtual void write(unsigned int dgId, const unsigned char* data);
@@ -70,7 +66,7 @@ private:
 	unsigned char                  m_n;
 	CTimer                         m_pingTimer;
 	CTimer                         m_resetTimer;
-	FCS_STATE                      m_state;
+	DGID_STATUS                    m_state;
 
 	void writeOptions(const std::string& reflector);
 	void writeInfo();

DGIdGateway/IMRSNetwork.cpp

@@ -29,7 +29,8 @@
 
 CIMRSNetwork::CIMRSNetwork() :
 m_socket(IMRS_PORT),
-m_dgIds()
+m_dgIds(),
+m_state(DS_NOTOPEN)
 {
 }
 
@@ -61,7 +62,19 @@ bool CIMRSNetwork::open()
 {
 	LogMessage("Opening IMRS network connection");
 
-	return m_socket.open();
+	bool ret = m_socket.open();
+	if (!ret) {
+		m_state = DS_NOTOPEN;
+		return false;
+	} else {
+		m_state = DS_NOTLINKED;
+		return true;
+	}
+}
+
+DGID_STATUS CIMRSNetwork::getStatus()
+{
+	return m_state;
 }
 
 void CIMRSNetwork::write(unsigned int dgId, const unsigned char* data)
@@ -196,6 +209,8 @@ void CIMRSNetwork::close()
 	LogMessage("Closing IMRS network connection");
 
 	m_socket.close();
+
+	m_state = DS_NOTOPEN;
 }
 
 IMRSDGId* CIMRSNetwork::find(const sockaddr_storage& addr) const

DGIdGateway/IMRSNetwork.h

@@ -61,6 +61,8 @@ public:
 
 	virtual bool open();
 
+	virtual DGID_STATUS getStatus();
+
 	virtual void link();
 
 	virtual void write(unsigned int dgId, const unsigned char* data);
@@ -76,6 +78,7 @@ public:
 private:
 	CUDPSocket             m_socket;
 	std::vector<IMRSDGId*> m_dgIds;
+	DGID_STATUS            m_state;
 
 	IMRSDGId* find(const sockaddr_storage& address) const;
 	IMRSDGId* find(unsigned int dgId) const;

DGIdGateway/YSFNetwork.cpp

@@ -1,5 +1,5 @@
 /*
- *   Copyright (C) 2009-2014,2016,2017,2018 by Jonathan Naylor G4KLX
+ *   Copyright (C) 2009-2014,2016,2017,2018,2020 by Jonathan Naylor G4KLX
  *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
@@ -38,7 +38,7 @@ m_unlink(NULL),
 m_buffer(1000U, "YSF Network Buffer"),
 m_pollTimer(1000U, 5U),
 m_name(name),
-m_linked(true)
+m_state(DS_NOTOPEN)
 {
 	m_poll = new unsigned char[14U];
 	::memcpy(m_poll + 0U, "YSFP", 4U);
@@ -66,7 +66,7 @@ m_unlink(NULL),
 m_buffer(1000U, "YSF Network Buffer"),
 m_pollTimer(1000U, 5U),
 m_name(name),
-m_linked(false)
+m_state(DS_NOTOPEN)
 {
 	m_poll = new unsigned char[14U];
 	::memcpy(m_poll + 0U, "YSFP", 4U);
@@ -113,19 +113,32 @@ bool CYSFNetwork::open()
 {
 	if (m_addrLen == 0U) {
 		LogError("Unable to resolve the address of the YSF network");
+		m_state = DS_NOTOPEN;
 		return false;
 	}
 
 	LogMessage("Opening YSF network connection");
 
-	return m_socket.open(m_addr);
+	bool ret = m_socket.open(m_addr);
+	if (!ret) {
+		m_state = DS_NOTOPEN;
+		return false;
+	} else {
+		m_state = DS_NOTLINKED;
+		return true;
+	}
+}
+
+DGID_STATUS CYSFNetwork::getStatus()
+{
+	return m_state;
 }
 
 void CYSFNetwork::write(unsigned int dgid, const unsigned char* data)
 {
 	assert(data != NULL);
 
-	if (!m_linked)
+	if (m_state != DS_LINKED)
 		return;
 
 	if (m_debug)
@@ -136,11 +149,19 @@ void CYSFNetwork::write(unsigned int dgid, const unsigned char* data)
 
 void CYSFNetwork::link()
 {
+	if (m_state != DS_NOTLINKED)
+		return;
+
 	writePoll();
+
+	m_state = DS_LINKING;
 }
 
 void CYSFNetwork::writePoll()
 {
+	if (m_state != DS_LINKING && m_state != DS_LINKED)
+		return;
+
 	m_pollTimer.start();
 
 	m_socket.write(m_poll, 14U, m_addr, m_addrLen);
@@ -151,15 +172,21 @@ void CYSFNetwork::writePoll()
 
 void CYSFNetwork::unlink()
 {
+	if (m_state != DS_LINKED)
+		return;
+
 	m_pollTimer.stop();
 
 	m_socket.write(m_unlink, 14U, m_addr, m_addrLen);
 
-	m_linked = false;
+	m_state = DS_NOTLINKED;
 }
 
 void CYSFNetwork::clock(unsigned int ms)
 {
+	if (m_state == DS_NOTOPEN)
+		return;
+
 	m_pollTimer.clock(ms);
 	if (m_pollTimer.isRunning() && m_pollTimer.hasExpired())
 		writePoll();
@@ -184,13 +211,13 @@ void CYSFNetwork::clock(unsigned int ms)
 	if (::memcmp(buffer, "YSFO", 4U) == 0)
 		return;
 
-	if (::memcmp(buffer, "YSFP", 4U) == 0 && !m_linked) {
+	if (::memcmp(buffer, "YSFP", 4U) == 0 && m_state == DS_LINKING) {
 		if (strcmp(m_name.c_str(),"MMDVM")== 0)
 			LogMessage("Link successful to %s", m_name.c_str());
 		else
 			LogMessage("Linked to %s", m_name.c_str());
 
-		m_linked = true;
+		m_state = DS_LINKED;
 
 		if (m_options != NULL)
 			m_socket.write(m_options, 50U, m_addr, m_addrLen);
@@ -222,4 +249,6 @@ void CYSFNetwork::close()
 	m_socket.close();
 
 	LogMessage("Closing YSF network connection");
+
+	m_state = DS_NOTOPEN;
 }

DGIdGateway/YSFNetwork.h

@@ -40,6 +40,8 @@ public:
 
 	virtual bool open();
 
+	virtual DGID_STATUS getStatus();
+
 	virtual void link();
 
 	virtual void write(unsigned int dgId, const unsigned char* data);
@@ -63,7 +65,7 @@ private:
 	CRingBuffer<unsigned char> m_buffer;
 	CTimer                     m_pollTimer;
 	std::string                m_name;
-	bool                       m_linked;
+	DGID_STATUS                m_state;
 
 	void writePoll();
 };