classref: Sync with latest 4.0-dev

classes/class_dtlsserver.rst

@@ -9,7 +9,7 @@
 DTLSServer
 ==========
 
-**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
+**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
 
 Helper class to implement a DTLS server.
 
@@ -20,9 +20,12 @@ This class is used to store the state of a DTLS server. Upon :ref:`setup<class_D
 
 Below a small example of how to use it:
 
-::
 
-    # server.gd
+.. tabs::
+
+ .. code-tab:: gdscript
+
+    # ServerNode.gd
     extends Node
     
     var dtls := DTLSServer.new()
@@ -43,6 +46,7 @@ Below a small example of how to use it:
                 continue # It is normal that 50% of the connections fails due to cookie exchange.
             print("Peer connected!")
             peers.append(dtls_peer)
+    
         for p in peers:
             p.poll() # Must poll to update the state.
             if p.get_status() == PacketPeerDTLS.STATUS_CONNECTED:
@@ -50,9 +54,61 @@ Below a small example of how to use it:
                     print("Received message from client: %s" % p.get_packet().get_string_from_utf8())
                     p.put_packet("Hello DTLS client".to_utf8())
 
-::
+ .. code-tab:: csharp
 
-    # client.gd
+    using Godot;
+    using System;
+    // ServerNode.cs
+    public class ServerNode : Node
+    {
+        public DTLSServer Dtls = new DTLSServer();
+        public UDPServer Server = new UDPServer();
+        public Godot.Collections.Array<PacketPeerDTLS> Peers = new Godot.Collections.Array<PacketPeerDTLS>();
+        public override void _Ready()
+        {
+            Server.Listen(4242);
+            var key = GD.Load<CryptoKey>("key.key"); // Your private key.
+            var cert = GD.Load<X509Certificate>("cert.crt"); // Your X509 certificate.
+            Dtls.Setup(key, cert);
+        }
+    
+        public override void _Process(float delta)
+        {
+            while (Server.IsConnectionAvailable())
+            {
+                PacketPeerUDP peer = Server.TakeConnection();
+                PacketPeerDTLS dtlsPeer = Dtls.TakeConnection(peer);
+                if (dtlsPeer.GetStatus() != PacketPeerDTLS.Status.Handshaking)
+                {
+                    continue; // It is normal that 50% of the connections fails due to cookie exchange.
+                }
+                GD.Print("Peer connected!");
+                Peers.Add(dtlsPeer);
+            }
+    
+            foreach (var p in Peers)
+            {
+                p.Poll(); // Must poll to update the state.
+                if (p.GetStatus() == PacketPeerDTLS.Status.Connected)
+                {
+                    while (p.GetAvailablePacketCount() > 0)
+                    {
+                        GD.Print("Received Message From Client: " + p.GetPacket().GetStringFromUTF8());
+                        p.PutPacket("Hello Dtls Client".ToUTF8());
+                    }
+                }
+            }
+        }
+    }
+
+
+
+
+.. tabs::
+
+ .. code-tab:: gdscript
+
+    # ClientNode.gd
     extends Node
     
     var dtls := PacketPeerDTLS.new()
@@ -73,6 +129,43 @@ Below a small example of how to use it:
                 print("Connected: %s" % dtls.get_packet().get_string_from_utf8())
                 connected = true
 
+ .. code-tab:: csharp
+
+    using Godot;
+    using System.Text;
+    // ClientNode.cs
+    public class ClientNode : Node
+    {
+        public PacketPeerDTLS Dtls = new PacketPeerDTLS();
+        public PacketPeerUDP Udp = new PacketPeerUDP();
+        public bool Connected = false;
+        public override void _Ready()
+        {
+            Udp.ConnectToHost("127.0.0.1", 4242);
+            Dtls.ConnectToPeer(Udp, false); // Use true in production for certificate validation!
+        }
+    
+        public override void _Process(float delta)
+        {
+            Dtls.Poll();
+            if (Dtls.GetStatus() == PacketPeerDTLS.Status.Connected)
+            {
+                if (!Connected)
+                {
+                    // Try to contact server
+                    Dtls.PutPacket("The Answer Is..42!".ToUTF8());
+                }
+                while (Dtls.GetAvailablePacketCount() > 0)
+                {
+                    GD.Print("Connected: " + Dtls.GetPacket().GetStringFromUTF8());
+                    Connected = true;
+                }
+            }
+        }
+    }
+
+
+
 Methods
 -------
 
@@ -99,5 +192,11 @@ Setup the DTLS server to use the given ``private_key`` and provide the given ``c
 
 Try to initiate the DTLS handshake with the given ``udp_peer`` which must be already connected (see :ref:`PacketPeerUDP.connect_to_host<class_PacketPeerUDP_method_connect_to_host>`).
 
-**Note**: You must check that the state of the return PacketPeerUDP is :ref:`PacketPeerDTLS.STATUS_HANDSHAKING<class_PacketPeerDTLS_constant_STATUS_HANDSHAKING>`, as it is normal that 50% of the new connections will be invalid due to cookie exchange.
+**Note:** You must check that the state of the return PacketPeerUDP is :ref:`PacketPeerDTLS.STATUS_HANDSHAKING<class_PacketPeerDTLS_constant_STATUS_HANDSHAKING>`, as it is normal that 50% of the new connections will be invalid due to cookie exchange.
 
+.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
+.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
+.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
+.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
+.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
+.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`