1. Epic GamesDeveloper
  3. FUdpSocketBuilder

FUdpSocketBuilder

Implements a fluent builder for UDP sockets.

API > API/Runtime > API/Runtime/Networking > API/Runtime/Networking/Common

References

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

Syntax

class FUdpSocketBuilder

Remarks

Implements a fluent builder for UDP sockets.

Constructors

  Type Name Description
Public function  

FUdpSocketBuilder ( const FString& InDescription
)

 Creates and initializes a new instance.

Functions

  Type Name Description
Public function FUdpSocketBuilder & Sets socket operations to be blocking.
Public function FUdpSocketBuilder & Sets socket operations to be non-blocking.
Public function FUdpSocketBuilder & Makes the bound address reusable by other sockets.
Public function FUdpSocketBuilder &

BoundToAddress ( const FIPv4Address& Address
)

 Sets the local address to bind the socket to.
Public function FUdpSocketBuilder &

BoundToEndpoint ( const FIPv4Endpoint& Endpoint
)

 Sets the local endpoint to bind the socket to.
Public function FUdpSocketBuilder &

BoundToPort ( uint16 Port
)

 Sets the local port to bind the socket to.
Public function Const FSocket *

Build ()

 Builds the socket as configured.
Public function FUdpSocketBuilder &

JoinedToGroup ( const FIPv4Address& GroupAddress,
const FIPv4Address& InterfaceAddress
)

 Joins the socket to the specified multicast group.
Public function FUdpSocketBuilder &

JoinedToGroup ( const FIPv4Address& GroupAddress
)

 Joins the socket to the specified multicast group.
Public function FUdpSocketBuilder & Enables broadcasting.
Public function FUdpSocketBuilder &

WithMulticastInterface ( const FIPv4Address& InterfaceAddress
)

 Sets the multicast outgoing interface.
Public function FUdpSocketBuilder & Enables multicast loopback.
Public function FUdpSocketBuilder &

WithMulticastTtl ( uint8 TimeToLive
)

 Sets the multicast time-to-live.
Public function FUdpSocketBuilder &

WithReceiveBufferSize ( int32 SizeInBytes
)

 Specifies the desired size of the receive buffer in bytes (0 = default).
Public function FUdpSocketBuilder &

WithSendBufferSize ( int32 SizeInBytes
)

 Specifies the desired size of the send buffer in bytes (0 = default).

Operators

  Type Name Description
Public function Const   Implicit conversion operator that builds the socket as configured.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page