soRecvFrom (Function)

The soRecvFrom function is identical to the soRecv function, except it also returns the local address and the address the data originated from.

The soRecvFrom function is typically used with connectionless sockets, where this is the only way to get the source address (and local address).

Input:

socket : SYSHANDLE

Handle to the socket.

data : PTR

Address of the buffer that contains the received data.

maxsize : DINT

Maximum number of bytes that can be received (size of "data").

Output:

size : DINT

The number of bytes received.

local : STRING

The socket address of the network interface where the data was received.

remote : STRING

The socket address of the source of the data.

Returns: INT

Declaration:

FUNCTION soRecvFrom : INT;
VAR_INPUT
   socket  : SYSHANDLE;
   data    : PTR;
   maxsize : DINT;
   size    : ACCESS DINT;
   local   : ACCESS STRING;
   remote  : ACCESS STRING;
END_VAR;

Example:

INCLUDE rtcu.inc
 
PROGRAM udp_example;
VAR
  handle  : SYSHANDLE;
  address : STRING;
 
  buf     : ARRAY [1..230] OF SINT;
  size    : DINT;
  local   : STRING;
  remote  : STRING;
  rc      : INT;
 
  port    : DINT;
  host    : STRING;
  str     : STRING;
END_VAR;
 
// Open network
netOpen(iface := _NET_IFACE_LAN1);
 
// Open UDP socket
rc := soCreate(type := _SO_TYPE_DGRAM, protocol := _SO_PROT_UDP, socket := handle);
IF rc < 1 THEN
  // Error handling
  DebugFmt(message := "soCreate=\1", v1 := rc);
END_IF;
 
// Listen to port 5022 on any network interface
soAddrInetSet(address := address, port := 5022);
rc := soBind(socket := handle, address := address);
IF rc < 1 THEN
  // Error handling
  DebugFmt(message := "soBind=\1", v1 := rc);
END_IF;
 
BEGIN
  // Read data (blocks until data is available)
  rc  := soRecvFrom(
                    socket  := handle,
                    data    := ADDR(buf),
                    maxsize := SIZEOF(buf),
                    size    := size,
                    local   := local,
                    remote  := remote
                   );
  IF rc < 1 THEN
    // Error handling
  END_IF;
 
  // Get information
  soAddrInetGet(address := remote, host := host, port := port);
  str := strFromMemory(src := ADDR(buf), len := INT(size));
 
  // Show information
  DebugFmt(message := " soRecvFrom    = \1", v1 := rc);
  DebugFmt(message := "    interface  = \1", v1 := soAddrToInterface(address := local));
  DebugMsg(message := "    IP address = " + host);
  DebugFmt(message := "    IP port    = \4", v4 := port);
  DebugMsg(message := "    data       = [" + str + "]");
END;
END_PROGRAM;