godot.gen.godot.DTLSServer.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of godot-library-debug Show documentation
Contains godot api as kotlin classes and jvm cpp interaction code.
There is a newer version: 0.11.0-4.3
// THIS FILE IS GENERATED! DO NOT EDIT IT MANUALLY!
@file:Suppress("PackageDirectoryMismatch", "unused", "FunctionName", "RedundantModalityModifier",
    "UNCHECKED_CAST", "JoinDeclarationAndAssignment", "USELESS_CAST",
    "RemoveRedundantQualifierName", "NOTHING_TO_INLINE", "NON_FINAL_MEMBER_IN_OBJECT",
    "RedundantVisibilityModifier", "RedundantUnitReturnType", "MemberVisibilityCanBePrivate")

package godot

import godot.`annotation`.GodotBaseType
import godot.core.GodotError
import godot.core.TypeManager
import godot.core.VariantType.LONG
import godot.core.VariantType.OBJECT
import godot.core.memory.TransferContext
import godot.util.VoidPtr
import kotlin.Boolean
import kotlin.Int
import kotlin.Long
import kotlin.Suppress

/**
 * Helper class to implement a DTLS server.
 *
 * This class is used to store the state of a DTLS server. Upon [setup] it converts connected [godot.PacketPeerUDP] to [godot.PacketPeerDTLS] accepting them via [takeConnection] as DTLS clients. Under the hood, this class is used to store the DTLS state and cookies of the server. The reason of why the state and cookies are needed is outside of the scope of this documentation.
 *
 * Below a small example of how to use it:
 *
 * [codeblocks]
 *
 * [gdscript]
 *
 * # server_node.gd
 *
 * extends Node
 *
 *
 *
 * var dtls := DTLSServer.new()
 *
 * var server := UDPServer.new()
 *
 * var peers = []
 *
 *
 *
 * func _ready():
 *
 *     server.listen(4242)
 *
 *     var key = load("key.key") # Your private key.
 *
 *     var cert = load("cert.crt") # Your X509 certificate.
 *
 *     dtls.setup(key, cert)
 *
 *
 *
 * func _process(delta):
 *
 *     while server.is_connection_available():
 *
 *         var peer: PacketPeerUDP = server.take_connection()
 *
 *         var dtls_peer: PacketPeerDTLS = dtls.take_connection(peer)
 *
 *         if dtls_peer.get_status() != PacketPeerDTLS.STATUS_HANDSHAKING:
 *
 *             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:
 *
 *             while p.get_available_packet_count() > 0:
 *
 *                 print("Received message from client: %s" % p.get_packet().get_string_from_utf8())
 *
 *                 p.put_packet("Hello DTLS client".to_utf8_buffer())
 *
 * [/gdscript]
 *
 * [csharp]
 *
 * // ServerNode.cs
 *
 * using Godot;
 *
 *
 *
 * public partial class ServerNode : Node
 *
 * {
 *
 *     private DtlsServer _dtls = new DtlsServer();
 *
 *     private UdpServer _server = new UdpServer();
 *
 *     private Godot.Collections.Array _peers = new Godot.Collections.Array();
 *
 *
 *
 *     public override void _Ready()
 *
 *     {
 *
 *         _server.Listen(4242);
 *
 *         var key = GD.Load("key.key"); // Your private key.
 *
 *         var cert = GD.Load("cert.crt"); // Your X509 certificate.
 *
 *         _dtls.Setup(key, cert);
 *
 *     }
 *
 *
 *
 *     public override void _Process(double 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".ToUtf8Buffer());
 *
 *                 }
 *
 *             }
 *
 *         }
 *
 *     }
 *
 * }
 *
 * [/csharp]
 *
 * [/codeblocks]
 *
 * [codeblocks]
 *
 * [gdscript]
 *
 * # client_node.gd
 *
 * extends Node
 *
 *
 *
 * var dtls := PacketPeerDTLS.new()
 *
 * var udp := PacketPeerUDP.new()
 *
 * var connected = false
 *
 *
 *
 * func _ready():
 *
 *     udp.connect_to_host("127.0.0.1", 4242)
 *
 *     dtls.connect_to_peer(udp, false) # Use true in production for certificate validation!
 *
 *
 *
 * func _process(delta):
 *
 *     dtls.poll()
 *
 *     if dtls.get_status() == PacketPeerDTLS.STATUS_CONNECTED:
 *
 *         if !connected:
 *
 *             # Try to contact server
 *
 *             dtls.put_packet("The answer is... 42!".to_utf8_buffer())
 *
 *         while dtls.get_available_packet_count() > 0:
 *
 *             print("Connected: %s" % dtls.get_packet().get_string_from_utf8())
 *
 *             connected = true
 *
 * [/gdscript]
 *
 * [csharp]
 *
 * // ClientNode.cs
 *
 * using Godot;
 *
 * using System.Text;
 *
 *
 *
 * public partial class ClientNode : Node
 *
 * {
 *
 *     private PacketPeerDtls _dtls = new PacketPeerDtls();
 *
 *     private PacketPeerUdp _udp = new PacketPeerUdp();
 *
 *     private bool _connected = false;
 *
 *
 *
 *     public override void _Ready()
 *
 *     {
 *
 *         _udp.ConnectToHost("127.0.0.1", 4242);
 *
 *         _dtls.ConnectToPeer(_udp, validateCerts: false); // Use true in production for certificate validation!
 *
 *     }
 *
 *
 *
 *     public override void _Process(double delta)
 *
 *     {
 *
 *         _dtls.Poll();
 *
 *         if (_dtls.GetStatus() == PacketPeerDtls.Status.Connected)
 *
 *         {
 *
 *             if (!_connected)
 *
 *             {
 *
 *                 // Try to contact server
 *
 *                 _dtls.PutPacket("The Answer Is..42!".ToUtf8Buffer());
 *
 *             }
 *
 *             while (_dtls.GetAvailablePacketCount() > 0)
 *
 *             {
 *
 *                 GD.Print($"Connected: {_dtls.GetPacket().GetStringFromUtf8()}");
 *
 *                 _connected = true;
 *
 *             }
 *
 *         }
 *
 *     }
 *
 * }
 *
 * [/csharp]
 *
 * [/codeblocks]
 */
@GodotBaseType
public open class DTLSServer : RefCounted() {
  public override fun new(scriptIndex: Int): Boolean {
    callConstructor(ENGINECLASS_DTLSSERVER, scriptIndex)
    return true
  }

  /**
   * Setup the DTLS server to use the given [serverOptions]. See [godot.TLSOptions.server].
   */
  public fun setup(serverOptions: TLSOptions): GodotError {
    TransferContext.writeArguments(OBJECT to serverOptions)
    TransferContext.callMethod(rawPtr, MethodBindings.setupPtr, LONG)
    return GodotError.from(TransferContext.readReturnValue(LONG) as Long)
  }

  /**
   * Try to initiate the DTLS handshake with the given [udpPeer] which must be already connected (see [godot.PacketPeerUDP.connectToHost]).
   *
   * **Note:** You must check that the state of the return PacketPeerUDP is [godot.PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange.
   */
  public fun takeConnection(udpPeer: PacketPeerUDP): PacketPeerDTLS? {
    TransferContext.writeArguments(OBJECT to udpPeer)
    TransferContext.callMethod(rawPtr, MethodBindings.takeConnectionPtr, OBJECT)
    return (TransferContext.readReturnValue(OBJECT, true) as PacketPeerDTLS?)
  }

  public companion object

  internal object MethodBindings {
    public val setupPtr: VoidPtr = TypeManager.getMethodBindPtr("DTLSServer", "setup")

    public val takeConnectionPtr: VoidPtr =
        TypeManager.getMethodBindPtr("DTLSServer", "take_connection")
  }
}