Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FTcpSocketBuilder

Implements a fluent builder for TCP sockets.

Windows

MacOS

Linux

References

Module	Networking
Header	/Engine/Source/Runtime/Networking/Public/Common/TcpSocketBuilder.h
Include	#include "Common/TcpSocketBuilder.h"

Syntax

class FTcpSocketBuilder

Remarks

Implements a fluent builder for TCP sockets.

Constructors

	Name	Description
	FTcpSocketBuilder ( const FString& InDescription )	Creates and initializes a new instance.

Functions

	Name	Description
FTcpSocketBu...	AsBlocking()	Sets socket operations to be blocking.
FTcpSocketBu...	AsNonBlocking()	Sets socket operations to be non-blocking.
FTcpSocketBu...	AsReusable()	Makes the bound address reusable by other sockets.
FTcpSocketBu...	AsReusable ( bool bInReusable )	Sets re-usability of the bound address by other sockets.
FTcpSocketBu...	BoundToAddress ( const FIPv4Address& Address )	Sets the local address to bind the socket to.
FTcpSocketBu...	BoundToEndpoint ( const FIPv4Endpoint& Endpoint )	Sets the local endpoint to bind the socket to.
FTcpSocketBu...	BoundToPort ( int32 Port )	Sets the local port to bind the socket to.
FSocket *...	Build()	Builds the socket as configured.
FTcpSocketBu...	Lingering ( int32 Timeout )	Sets how long the socket will linger after closing.
FTcpSocketBu...	Listening ( int32 MaxBacklog )	Sets the socket into a listening state for incoming connections.
FTcpSocketBu...	WithReceiveBufferSize ( int32 SizeInBytes )	Specifies the desired size of the receive buffer in bytes (0 = default).
FTcpSocketBu...	WithSendBufferSize ( int32 SizeInBytes )	Specifies the desired size of the send buffer in bytes (0 = default).

Operators

		Name	Description
		operator FSocket *()	Implicit conversion operator that builds the socket as configured.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss