Internet Protocol
Unreal Engine Plugin

UDP Client

How to use UDP client class

References

#include "udp/udpclient.h"

How to use

Blueprint: search by GetInternetProtocolSubsystem and call CreateUDPClient function

C++: Use the code bellow

#include "UDP/UDPClient.h"

UUDPClient* client = NewObject<UUDPClient>();

Nodes

Is Open

  • Return true if socket is open.
𝑓
Is Open
Return Value
Output pin

Local Endpoint

  • Get the local endpoint of the socket. Use this function only after open connection.
𝑓
Local Endpoint
Return Value
Output pin

Remote Endpoint

  • Get the remote endpoint of the socket. Use this function only after open connection.
𝑓
Remote Endpoint
Return Value
Output pin

Get Error Code

  • Return a struct of the latest error code returned by asio.
𝑓
Get Error Code
Return Value
Output pin

Set Recv Buffer Size

  • Set receive buffer size in bytes
𝑓
Set Recv Buffer Size
Target is UDPClient
Input pin
Input pin
Target
Input pin
Value
Output pin

Get Max Send Buffer Size

  • Get receive buffer size in bytes
𝑓
Get Recv Buffer Size
Target is UDPClient
Input pin
Target
Return Value
Output pin

Send

  • Broadcasts a string to an specific endpoint.
  • It returns false if socket is closed or if buffer is empty.
𝑓
Send
Target is UDPClient
Input pin
Input pin
Target
Input pin
Message
Input pin
Callback
Output pin
Return Value
Output pin
On Message Sent
Custom Event
Output pin
Error Code
Output pin
Bytes Sent
Output pin

Send Buffer

  • Broadcasts a buffer to an specific endpoint.
  • It returns false if socket is closed or if buffer is empty.
𝑓
Send Buffer
Target is UDPClient
Input pin
Input pin
Target
Input pin
Buffer
Input pin
Callback
Output pin
Return Value
Output pin
On Message Sent
Custom Event
Output pin
Error Code
Output pin
Bytes Sent
Output pin

Connect

  • Listen for datagram messages on a named port and address.
  • It returns false if socket is already open or if asio return any error code during the bind.
𝑓
Connect
Target is UDPClient
Input pin
Input pin
Target
Input pin
Bind Opts
Output pin
Return Value
Output pin

Close

  • Close the underlying socket and stop listening for data on it. 'on_close' event will be triggered.
𝑓
Close
Target is UDPClient
Input pin
Input pin
Target
Output pin

Events

On Connected

  • Event triggered when a connection is estabilished.
Bind Event to On Connected
Input pin
Input pin
Target
Input pin
Event
Output pin
On Connected
Custom Event
Output pin

On Message

  • Event triggered when socket send or receive data.
Bind Event to On Message
Input pin
Input pin
Target
Input pin
Event
Output pin
On Message
Custom Event
Output pin
Buffer
Output pin
Bytes Recvd
Output pin

On Close

  • Event triggered when socket is closed.
Bind Event to On Close
Input pin
Input pin
Target
Input pin
Event
Output pin
On Close
Custom Event
Output pin

On Error

  • Event triggered if any error occur during async process.
Bind Event to On Error
Input pin
Input pin
Target
Input pin
Event
Output pin
On Error
Custom Event
Output pin
Error Code
Output pin

Websocket Server Openssl

How to use Websocket server class with openssl

TCP Client

How to use TCP client class

On this page

ReferencesHow to useNodesIs OpenLocal EndpointRemote EndpointGet Error CodeSet Recv Buffer SizeGet Max Send Buffer SizeSendSend BufferConnectCloseEventsOn ConnectedOn MessageOn CloseOn Error