1. Epic GamesDeveloper
  3. UUdpMessagingSettings

UUdpMessagingSettings

API > API/Plugins > API/Plugins/UdpMessaging

   
Name UUdpMessagingSettings
Type class
Header File /Engine/Plugins/Messaging/UdpMessaging/Source/UdpMessaging/Public/Shared/UdpMessagingSettings.h
Include Path #include "Shared/UdpMessagingSettings.h"

Syntax

UCLASS (Config=Engine)  
class UUdpMessagingSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UUdpMessagingSettings ( const FObjectInitializer& ObjectInitializer
)

   Shared/UdpMessagingSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AutoRepairAttemptLimit uint32 The number of consecutive attempt the auto repair routine will try to repair. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • AdvancedDisplay
bAutoRepair bool Whether the UDP transport channel should try to auto repair when in error. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • AdvancedDisplay
bShareKnownNodesWithActiveConnections bool Whether to share our list of known endpoints with those endpoints. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • AdvancedDisplay
bStopServiceWhenAppDeactivates bool Whether to stop the transport service when the application deactivates, and restart it when the application is reactivated Shared/UdpMessagingSettings.h
  • Config
ConnectionTimeoutPeriod float The period of time to consider an active connection to be timed-out. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • Meta=(ClampMin="0")
  • AdvancedDisplay
EnabledByDefault bool Whether UDP messaging is enabled by default. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Availability
EnableTransport bool Whether the UDP transport channel is enabled. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
EnableTunnel bool Whether the UDP tunnel is enabled. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Tunnel
ExcludedEndpoints TArray< FString > List of IP addresses that are banned from communicating with this client. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • AdvancedDisplay
MaxConcurrentDeserializationTasks uint32 Maximum number of deserialization tasks that can be performed in parallel. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • Meta=(ClampMax="32")
  • AdvancedDisplay
MaxSendRate float Maximum sustained transmission rate in Gbit / s. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • AdvancedDisplay
MessageFormat EUdpMessageFormat The format used to serialize the UDP message payload. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
MulticastEndpoint FString The IP endpoint to send multicast packets to. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
MulticastTimeToLive uint8 The time-to-live (TTL) for sent multicast packets. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • AdvancedDisplay
ReliableQueuePriority float Reliable queue priority specified as a percentage with a range from 5-95%. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • Meta=(ClampMin="5", ClampMax="95")
  • AdvancedDisplay
RemoteTunnelEndpoints TArray< FString > The IP endpoints of remote tunnel nodes. Shared/UdpMessagingSettings.h  
StaticEndpoints TArray< FString > The IP endpoints of static devices. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • AdvancedDisplay
TunnelMulticastEndpoint FString The IP endpoint to send multicast packets to. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Tunnel
TunnelUnicastEndpoint FString The local IP endpoint to listen to and send packets from.    

The format is IP_ADDRESS:PORT_NUMBER. | Shared/UdpMessagingSettings.h |

  • Config
  • EditAnywhere
  • Category=Tunnel
|
UnicastEndpoint FString The IP endpoint to listen to and send packets from. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
WorkQueueSize uint16 The buffer size for the working send queues. Shared/UdpMessagingSettings.h
  • Config
  • EditAnywhere
  • Category=Transport
  • Meta=(ClampMin="1024")
  • AdvancedDisplay

Functions

Public

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page