1. Epic GamesDeveloper
  3. UIpNetDriver

UIpNetDriver

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

Inheritance Hierarchy

References

   
Module OnlineSubsystemUtils
Header /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Classes/IpNetDriver.h
Include #include "IpNetDriver.h"

Syntax

UCLASS&40;Transient, Config&61;Engine&41;  
class UIpNetDriver : public UNetDriver

Variables

  Type Name Description
Public variable UProperty Config uint32: 1 AllowPlayerPortUnreach Does the game allow clients to remain after receiving ICMP port unreachable errors (handles flakey connections)
Public variable UProperty Config uint32: 1 bExitOnBindFailure Whether to exit if binding a port failed.
Public variable UProperty Config uint32: 1 LogPortUnreach Should port unreachable messages be logged
Public variable UProperty Config uint32 MaxPortCountToTry Number of ports which will be tried if current one is not available for binding (i.e. if told to bind to port N, will try from N to N+MaxPortCountToTry inclusive)
Public variable float PauseReceiveEnd If pausing socket receives, the time at which this should end

Constructors

  Type Name Description
Public function  

UIpNetDriver ( const FObjectInitializer& ObjectInitializer
)

 Base constructorUIpNetDriver

Functions

  Type Name Description
Protected function Virtual FUniqueSocket

CreateAndBindSocket ( TSharedRef< FInternetAddr > BindAddr,
int32 Port,
bool bReuseAddressAndPort,
int32 DesiredRecvSize,
int32 DesiredSendSize,
FString& Error
)

 Creates, initializes and binds a socket using the given bind address information.
Protected function Virtual FUniqueSocket

CreateSocketForProtocol ( const FName& ProtocolType
)

 Creates a socket set up for communication using the given protocol.
Public function Virtual int Returns the port number to use when a client is creating a socket.
Public function Const double Returns the last time socket recreation was kicked off or completed
Public function Const float  
Public function UIpConnection *  
Public function Virtual FSocket * Returns the current FSocket to be used with this NetDriver.
Public function bool

HandlePauseReceiveCommand ( const TCHAR* Cmd,
FOutputDevice& Ar,
UWorld* InWorld
)

  
Public function bool

HandleRecreateSocketCommand ( const TCHAR* Cmd,
FOutputDevice& Ar,
UWorld* InWorld
)

  
Public function bool

HandleSocketsCommand ( const TCHAR* Cmd,
FOutputDevice& Ar,
UWorld* InWorld
)

 Exec command handlers
Public function UE::Net::ERecreateSocketResult

RecreateSocket ( int32 OverridePort
)

 Creates a new Socket for the NetDriver/NetConnection's, based on the address/binding of the existing socket, with a new ephemeral port.
Public function void

SetSocketAndLocalAddress ( const TSharedPtr< FSocket >& SharedSocket
)

 Set the current NetDriver's Socket/LocalAddr to the given socket (typically after Net Address Resolution).
Protected function void

SetSupportsRecreateSocket ( bool bInSupportsRecreateSocket
)

 Called by NetDriver subclasses, to specify whether or not they support recreating the active socket
Public function void

TestSuddenPortChange ( uint32 NumConnections
)

 Tests a scenario where a connected client suddenly starts sending traffic on a different port (can happen due to a rare router bug.

Overridden from UNetDriver

  Type Name Description
Public function Virtual ISocketSubsystem * Get the socket subsytem appropriate for this net driver
Public function Virtual bool

InitBase ( bool bInitAsClient,
FNetworkNotify* InNotify,
const FURL& URL,
bool bReuseAddressAndPort,
FString& Error
)

 Common initialization between server and client connection setup
Public function Virtual bool

InitConnect ( FNetworkNotify* InNotify,
const FURL& ConnectURL,
FString& Error
)

 Initialize the net driver in client mode
Public function Virtual bool

InitListen ( FNetworkNotify* InNotify,
FURL& ListenURL,
bool bReuseAddressAndPort,
FString& Error
)

 Initialize the network driver in server mode (listener)
Public function Virtual Const bool Returns true if this net driver is valid for the current configuration.
Public function Virtual bool  
Public function Virtual void Close socket and Free the memory the OS allocated for this socket
Public function Virtual FString  
Public function Virtual void

LowLevelSend ( TSharedPtr< const FInternetAddr > Address,
void* Data,
int32 CountBits,
FOutPacketTraits& Traits
)

 Sends a 'connectionless' (not associated with a UNetConection) packet, to the specified address.
Public function Virtual void

TickDispatch ( float DeltaTime
)

 Handle time update: read and process packets

Enums

  Type Name Description
Private enum ESocketState The current state of the NetDriver socket  

Typedefs

Name Description
FOnNetworkProcessingCausingSlowFrame Callback for platform handling when networking is taking a long time in a single frame (by default over 1 second).

Constants

Name Description
OnNetworkProcessingCausingSlowFrame  

Deprecated Functions

  Type Name Description
Public function void Use the version of SetSocketAndLocalAddress which takes a TSharedPtr

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page