UIpConnection

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

OnlineSubsystemUtils

Header

/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Classes/IpConnection.h

Include

#include "IpConnection.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, Config=Engine)
class UIpConnection : public UNetConnection

Variables

Name Description

Public variable

FSocket *

 

Socket

This is a non-owning pointer to a socket owned elsewhere, IpConnection will not destroy the socket through this pointer.

Constructors

Name Description

Public function

UIpConnection

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

DisableAddressResolution()

Disables address resolution by pushing the disabled flag into the status field.

Public function

void

 

WaitForSendTasks()

If CVarNetIpConnectionUseSendTasks is true, blocks until there are no outstanding send tasks.

Overridden from UNetConnection

Name Description

Public function Virtual

void

 

CleanUp()

Closes the control channel, cleans up structures, and prepares for deletion

Public function Virtual

float

 

GetTimeoutValue()

Return current timeout value that should be used

Protected function Virtual

void

 

HandleConnectionTimeout

(
    const FString& ErrorStr
)

Handles a NetConnection timeout.

Public function Virtual

void

 

InitBase

(
    UNetDriver* InDriver,
    FSocket* InSocket,
    const FURL& InURL,
    EConnectionState InState,
    int32 InMaxPacket,
    int32 InPacketOverhead
)

Initialize common settings for this connection instance

Public function Virtual

void

 

InitLocalConnection

(
    UNetDriver* InDriver,
    FSocket* InSocket,
    const FURL& InURL,
    EConnectionState InState,
    int32 InMaxPacket,
    int32 InPacketOverhead
)

Initialize this connection instance to a remote source

Public function Virtual

void

 

InitRemoteConnection

(
    UNetDriver* InDriver,
    FSocket* InSocket,
    const FURL& InURL,
    const FInternetAddr& InRemoteAddr,
    EConnectionState InState,
    int32 InMaxPacket,
    int32 InPacketOverhead
)

Initialize this connection instance from a remote source

Public function Virtual

FString

 

LowLevelDescribe()

Public function Virtual

FString

 

LowLevelGetRemoteAddress

(
    bool bAppendPort
)

Public function Virtual

void

 

LowLevelSend

(
    void* Data,
    int32 CountBits,
    FOutPacketTraits& Traits
)

Sends a byte stream to the remote endpoint using the underlying socket

Public function Virtual

void

 

ReceivedRawPacket

(
    void* Data,
    int32 Count
)

Allows the connection to process the raw data that was received

Public function Virtual

void

 

Tick()

Poll the connection. If it is timed out, close it.

Deprecated Variables

Name Description

Public variable

FResolveInfo &#...

 

ResolveInfo

Address resolution is now handled in the IpNetDriver and no longer done entirely in the IpConnection
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss