1. Epic GamesDeveloper
  3. FQuicEndpointManager

FQuicEndpointManager

QUIC endpoint manager

API > API/Plugins > API/Plugins/QuicMessagingTransport

References

   
Module QuicMessagingTransport
Header /Engine/Plugins/Experimental/QuicMessaging/Source/QuicMessagingTransport/Public/QuicEndpointManager.h
Include #include "QuicEndpointManager.h"

Syntax

class FQuicEndpointManager

Remarks

QUIC endpoint manager

Authentication:

  • If AuthenticationMode is Enabled, QuicServerHandler will discard any message with MessageType other than "Authentication" until the node associated with the handler is marked as authenticated
  • Messages with type "Authentication" or "AuthenticationResponse" can be sent via the extension methods found in IQuicNetworkMessagingExtension.h
  • The MaxAuthenticationMessageSize limit can be set to avoid reading potentially large malicious authentication messages

Client/Server:

  • The EndpointManager will start in client mode by default and is converted to a server endpoint when SetServerMode is called with additional parameters needed to run a server
  • QuicServerHandlers will continuously ping the connected client to keep the connection alive

Constructors

  Type Name Description
Public function    
Public function   Initialize endpoint manager with default mode as client.

Destructors

  Type Name Description
Public function   Default destructor.

Functions

  Type Name Description
Public function void

AddClient ( const FIPv4Endpoint& ClientEndpoint
)

 Add remote endpoint client.
Protected function void Regularly called to check if any of the endpoints have reached the discovery timeout.
Protected function void

CheckLoseNode ( const FIPv4Endpoint LostEndpoint
)

 Checks if the lost endpoint node is still registered and removes it.
Protected function Const FMessageHeader

DeserializeHeader ( const FQuicPayloadPtr HeaderData
)

 Forward for the deserialize header delegate.
Public function void

DisconnectEndpoint ( const FIPv4Endpoint& Endpoint
)

 Disconnect an endpoint.
Public function void

DisconnectNode ( const FGuid& NodeId
)

 Disconnect a node.
Protected function void

EndpointConnected ( const FIPv4Endpoint& ConnectedEndpoint
)

 Adds a DiscoveryTimeout entry if discovery timeouts are enabled.
Protected function void

EndpointDisconnected ( const FIPv4Endpoint DisconnectedEndpoint,
EQuicEndpointError Reason
)

 Removes a disconnected endpoint.
Public function void

EndpointNodeDiscovered ( const FGuid NodeId,
const FIPv4Endpoint& NodeEndpoint,
const FIPv4Endpoint& LocalEndpoint
)

 Register discovered endpoint node.
Public function void

EndpointNodeLost ( const FGuid NodeId,
const FIPv4Endpoint LostEndpoint
)

 De-register lost endpoint node.
Protected function void Updates a KnownNode with new endpoint transport statistics.
Public function void

EnqueueOutboundMessages ( FQuicPayloadPtr Data,
const TArray< TTuple< FGuid, uint32 >>& MessageMetas,
const EQuicMessageType MessageType
)

 Enqueues outbound messages on all recipient endpoints.
Public function Const TArray< FIPv4Endpoint > Get a list of the known endpoints.
Public function Const TOptional< FGuid >

GetKnownNodeId ( const FIPv4Endpoint& Endpoint
)

 Get the NodeId of a known endpoint.
Public function Const TArray< FGuid > Get a list of known NodeIds.
Public function Const FMessageTransportStatistics

GetStats ( FGuid NodeId
)

 Get the network/transport statistics for a node.
Public function void Set endpoint manager to operate in server mode and initialize server.
Public function Const bool

IsEndpointAuthenticated ( const FGuid& NodeId
)

 Check if a QuicServerHandler endpoint is authenticated.This is only used for QuicServers
Public function Const bool

IsEndpointKnown ( const FIPv4Endpoint Endpoint
)

 Check if an endpoint is associated with a known node.
Protected function bool

IsMessageValid ( const FInboundMessage InboundMessage
)

 Checks if a message is valid.
Public function FOnClientConnectionChanged &  
Public function FOnDeserializeHeader &  
Public function FOnEndpointNodeDiscovered &  
Public function FOnEndpointNodeLost &  
Public function FOnMessageDelivered &  
Public function FOnMessageValidated &  
Public function FOnSerializeHeader &  
Public function void

ReconnectClient ( const FIPv4Endpoint ClientEndpoint
)

 Reconnect remote endpoint client.
Public function void

RemoveClient ( const FIPv4Endpoint& ClientEndpoint
)

 Remove remote endpoint client.
Protected function void

SendEndpointHello ( const FInboundMessage& InboundMessage
)

 Instructs the appropriate endpoint or handler to send a hello message.
Protected function Const FQuicPayloadPtr

SerializeHeader ( FMessageHeader& MessageHeader
)

 Forward for the serialize header delegate.
Public function void

SetEndpointAuthenticated ( const FGuid& NodeId
)

 Set QuicServerHandler endpoint as authenticated.This is only used for QuicServers
Public function void Shutdown endpoint manager and kill client/server threads.
Protected function void

ValidateInboundMessage ( const FInboundMessage InboundMessage
)

 Validates InboundMessage and passes it to MessageProcessor.

Typedefs

Name Description
FOnClientConnectionChanged Delegate for when a client connection changes.
FOnDeserializeHeader Delegate for when a header needs to be deserialized.
FOnEndpointNodeDiscovered Delegate for when a node was discovered.
FOnEndpointNodeLost Delegate for when a node was lost.
FOnMessageDelivered Delegate for when a message has been delivered.
FOnMessageValidated Delegate for when a message has been received and validated.
FOnSerializeHeader Delegate for when a header needs to be serialized.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page