96 lines
3.0 KiB
C++
96 lines
3.0 KiB
C++
// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "Engine/Platform/Network.h"
|
|
|
|
class ScriptingObject;
|
|
|
|
/// <summary>
|
|
/// Network driver implementations enum.
|
|
/// [Deprecated in v1.3]
|
|
/// </summary>
|
|
API_ENUM(Namespace="FlaxEngine.Networking") enum class DEPRECATED() NetworkDriverType
|
|
{
|
|
/// <summary>
|
|
/// Invalid network driver implementation.
|
|
/// </summary>
|
|
Undefined = 0,
|
|
|
|
/// <summary>
|
|
/// ENet library based network driver implementation.
|
|
/// </summary>
|
|
ENet
|
|
};
|
|
|
|
/// <summary>
|
|
/// Low-level network configuration structure. Provides settings for the network driver and all internal components.
|
|
/// </summary>
|
|
API_STRUCT(Namespace="FlaxEngine.Networking") struct FLAXENGINE_API NetworkConfig
|
|
{
|
|
DECLARE_SCRIPTING_TYPE_MINIMAL(NetworkConfig);
|
|
|
|
/// <summary>
|
|
/// The network driver that will be used to create the peer.
|
|
/// To allow two peers to connect, they must use the same host.
|
|
/// [Deprecated in v1.3]
|
|
/// </summary>
|
|
API_FIELD()
|
|
DEPRECATED("Use NetworkDriver field instead") NetworkDriverType NetworkDriverType;
|
|
|
|
/// <summary>
|
|
/// The network driver instance (implements INetworkDriver) that will be used to create and manage the peer, send and receive messages.
|
|
/// </summary>
|
|
/// <remarks>Object is managed by the created network peer (will be deleted on peer shutdown).</remarks>
|
|
API_FIELD()
|
|
ScriptingObject* NetworkDriver = nullptr;
|
|
|
|
/// <summary>
|
|
/// The upper limit on how many peers can join when we're listening.
|
|
/// </summary>
|
|
API_FIELD()
|
|
uint16 ConnectionsLimit = 32;
|
|
|
|
/// <summary>
|
|
/// Address used to connect to or listen at.
|
|
/// </summary>
|
|
/// <remarks>Set it to "any" when you want to listen at all available addresses.</remarks>
|
|
/// <remarks>Only IPv4 is supported.</remarks>
|
|
API_FIELD()
|
|
String Address = String(TEXT("127.0.0.1"));
|
|
|
|
/// <summary>
|
|
/// The port to connect to or listen at.
|
|
/// </summary>
|
|
API_FIELD()
|
|
uint16 Port = 7777;
|
|
|
|
/// <summary>
|
|
/// The size of a message buffer in bytes.
|
|
/// Should be lower than the MTU (maximal transmission unit) - typically 1500 bytes.
|
|
/// </summary>
|
|
API_FIELD()
|
|
uint16 MessageSize = 1500;
|
|
|
|
/// <summary>
|
|
/// The amount of pooled messages that can be used at once (receiving and sending!).
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creating more messages than this limit will result in a crash!
|
|
/// This should be tweaked manually to fit the needs (adjusting this value will increase/decrease memory usage)!
|
|
/// </remarks>
|
|
API_FIELD()
|
|
uint16 MessagePoolSize = 2048;
|
|
|
|
// Ignore deprecation warnings in defaults
|
|
PRAGMA_DISABLE_DEPRECATION_WARNINGS
|
|
NetworkConfig()
|
|
{
|
|
NetworkDriverType = NetworkDriverType::ENet;
|
|
}
|
|
NetworkConfig(const NetworkConfig& other) = default;
|
|
NetworkConfig(NetworkConfig&& other) = default;
|
|
NetworkConfig& operator=(const NetworkConfig& other) = default;
|
|
PRAGMA_ENABLE_DEPRECATION_WARNINGS
|
|
};
|