From 9c5162041e6e0699283862b87e2e424bf8e3b8b8 Mon Sep 17 00:00:00 2001
From: Mattes D <github@xoft.cz>
Date: Fri, 20 Feb 2015 14:28:05 +0100
Subject: cNetwork: Added UDP API.

---
 src/OSSupport/Network.h | 78 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 77 insertions(+), 1 deletion(-)

(limited to 'src/OSSupport/Network.h')

diff --git a/src/OSSupport/Network.h b/src/OSSupport/Network.h
index e883dfb29..5dd596223 100644
--- a/src/OSSupport/Network.h
+++ b/src/OSSupport/Network.h
@@ -130,6 +130,64 @@ public:
 
 
 
+/** Interface that provides methods available on UDP communication endpoints. */
+class cUDPEndpoint
+{
+public:
+	/** Interface for the callbacks for events that can happen on the endpoint. */
+	class cCallbacks
+	{
+	public:
+		// Force a virtual destructor in all descendants:
+		virtual ~cCallbacks() {}
+
+		/** Called when an error occurs on the endpoint. */
+		virtual void OnError(int a_ErrorCode, const AString & a_ErrorMsg) = 0;
+
+		/** Called when there is an incoming datagram from a remote host. */
+		virtual void OnReceivedData(const char * a_Data, size_t a_Size, const AString & a_RemoteHost, UInt16 a_RemotePort) = 0;
+	};
+
+
+	// Force a virtual destructor for all descendants:
+	virtual ~cUDPEndpoint() {}
+
+	/** Closes the underlying socket.
+	Note that there still might be callbacks in-flight after this method returns. */
+	virtual void Close(void) = 0;
+
+	/** Returns true if the endpoint is open. */
+	virtual bool IsOpen(void) const = 0;
+
+	/** Returns the local port to which the underlying socket is bound. */
+	virtual UInt16 GetPort(void) const = 0;
+
+	/** Sends the specified payload in a single UDP datagram to the specified host+port combination.
+	Note that in order to send to a broadcast address, you need to call EnableBroadcasts() first. */
+	virtual bool Send(const AString & a_Payload, const AString & a_Host, UInt16 a_Port) = 0;
+
+	/** Marks the socket as capable of sending broadcast, using whatever OS API is needed.
+	Without this call, sending to a broadcast address using Send() may fail. */
+	virtual void EnableBroadcasts(void) = 0;
+
+protected:
+	/** The callbacks used for various events on the endpoint. */
+	cCallbacks & m_Callbacks;
+
+
+	/** Creates a new instance of an endpoint, with the specified callbacks. */
+	cUDPEndpoint(cCallbacks & a_Callbacks):
+		m_Callbacks(a_Callbacks)
+	{
+	}
+};
+
+typedef SharedPtr<cUDPEndpoint> cUDPEndpointPtr;
+
+
+
+
+
 class cNetwork
 {
 public:
@@ -183,9 +241,22 @@ public:
 
 		/** Called when the hostname is successfully resolved into an IP address.
 		May be called multiple times if a name resolves to multiple addresses.
-		a_IP may be either an IPv4 or an IPv6 address with their proper formatting. */
+		a_IP may be either an IPv4 or an IPv6 address with their proper formatting.
+		Each call to OnNameResolved() is preceded by a call to either OnNameResolvedV4() or OnNameResolvedV6(). */
 		virtual void OnNameResolved(const AString & a_Name, const AString & a_IP) = 0;
 
+		/** Called when the hostname is successfully resolved into an IPv4 address.
+		May be called multiple times if a name resolves to multiple addresses.
+		Each call to OnNameResolvedV4 is followed by OnNameResolved with the IP address serialized to a string.
+		If this callback returns false, the OnNameResolved() call is skipped for this address. */
+		virtual bool OnNameResolvedV4(const AString & a_Name, const sockaddr_in * a_IP) { return true; }
+
+		/** Called when the hostname is successfully resolved into an IPv6 address.
+		May be called multiple times if a name resolves to multiple addresses.
+		Each call to OnNameResolvedV4 is followed by OnNameResolved with the IP address serialized to a string.
+		If this callback returns false, the OnNameResolved() call is skipped for this address. */
+		virtual bool OnNameResolvedV6(const AString & a_Name, const sockaddr_in6 * a_IP) { return true; }
+
 		/** Called when an error is encountered while resolving.
 		If an error is reported, the OnFinished() callback is not called. */
 		virtual void OnError(int a_ErrorCode, const AString & a_ErrorMsg) = 0;
@@ -242,6 +313,11 @@ public:
 		const AString & a_IP,
 		cResolveNameCallbacksPtr a_Callbacks
 	);
+
+	/** Opens up an UDP endpoint for sending and receiving UDP datagrams on the specified port.
+	If a_Port is 0, the OS is free to assign any port number it likes to the endpoint.
+	Returns the endpoint object that can be interacted with. */
+	static cUDPEndpointPtr CreateUDPEndpoint(UInt16 a_Port, cUDPEndpoint::cCallbacks & a_Callbacks);
 };
 
 
-- 
cgit v1.2.3