udp.h File Reference

UDP (User Datagram Protocol) More...

#include "core/net.h"
#include "core/tcp.h"

Go to the source code of this file.

Data Structures

struct  UdpRxCallbackEntry
 UDP receive callback entry. More...
 

Macros

#define UDP_SUPPORT   ENABLED
 
#define UDP_CALLBACK_TABLE_SIZE   10
 
#define UDP_RX_QUEUE_SIZE   4
 

Typedefs

typedef void(* UdpRxCallback) (NetInterface *interface, const IpPseudoHeader *pseudoHeader, const UdpHeader *header, const NetBuffer *buffer, size_t offset, const NetRxAncillary *ancillary, void *param)
 UDP receive callback. More...
 

Functions

error_t udpInit (void)
 UDP related initialization. More...
 
uint16_t udpGetDynamicPort (void)
 Get an ephemeral port number. More...
 
error_t udpProcessDatagram (NetInterface *interface, const IpPseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, const NetRxAncillary *ancillary)
 Incoming UDP datagram processing. More...
 
error_t udpSendDatagram (Socket *socket, const SocketMsg *message, uint_t flags)
 Send a UDP datagram. More...
 
error_t udpSendBuffer (NetInterface *interface, const IpAddr *srcIpAddr, uint16_t srcPort, const IpAddr *destIpAddr, uint16_t destPort, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
 Send a UDP datagram. More...
 
error_t udpReceiveDatagram (Socket *socket, SocketMsg *message, uint_t flags)
 Receive data from a UDP socket. More...
 
NetBufferudpAllocBuffer (size_t length, size_t *offset)
 Allocate a buffer to hold a UDP packet. More...
 
void udpUpdateEvents (Socket *socket)
 Update UDP related events. More...
 
error_t udpAttachRxCallback (NetInterface *interface, uint16_t port, UdpRxCallback callback, void *param)
 Register user callback. More...
 
error_t udpDetachRxCallback (NetInterface *interface, uint16_t port)
 Unregister user callback. More...
 
error_t udpInvokeRxCallback (NetInterface *interface, const IpPseudoHeader *pseudoHeader, const UdpHeader *header, const NetBuffer *buffer, size_t offset, const NetRxAncillary *ancillary)
 Invoke user callback. More...
 
void udpDumpHeader (const UdpHeader *datagram)
 Dump UDP header for debugging purpose. More...
 

Variables

typedef __packed_struct
 UDP header. More...
 
uint16_t destPort
 
uint16_t length
 
uint16_t checksum
 
uint8_t data []
 
 UdpHeader
 
UdpRxCallbackEntry udpCallbackTable [UDP_CALLBACK_TABLE_SIZE]
 

Detailed Description

UDP (User Datagram Protocol)

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2023 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.3.0

Definition in file udp.h.

Macro Definition Documentation

◆ UDP_CALLBACK_TABLE_SIZE

#define UDP_CALLBACK_TABLE_SIZE   10

Definition at line 48 of file udp.h.

◆ UDP_RX_QUEUE_SIZE

#define UDP_RX_QUEUE_SIZE   4

Definition at line 55 of file udp.h.

◆ UDP_SUPPORT

#define UDP_SUPPORT   ENABLED

Definition at line 40 of file udp.h.

Typedef Documentation

◆ UdpRxCallback

typedef void(* UdpRxCallback) (NetInterface *interface, const IpPseudoHeader *pseudoHeader, const UdpHeader *header, const NetBuffer *buffer, size_t offset, const NetRxAncillary *ancillary, void *param)

UDP receive callback.

Definition at line 96 of file udp.h.

Function Documentation

◆ udpAllocBuffer()

NetBuffer* udpAllocBuffer ( size_t  length,
size_t *  offset 
)

Allocate a buffer to hold a UDP packet.

Parameters
[in]lengthDesired payload length
[out]offsetOffset to the first byte of the payload
Returns
The function returns a pointer to the newly allocated buffer. If the system is out of resources, NULL is returned

Definition at line 885 of file udp.c.

◆ udpAttachRxCallback()

error_t udpAttachRxCallback ( NetInterface interface,
uint16_t  port,
UdpRxCallback  callback,
void *  param 
)

Register user callback.

Parameters
[in]interfaceUnderlying network interface
[in]portUDP port number
[in]callbackCallback function to be called when a datagram is received
[in]paramCallback function parameter (optional)
Returns
Error code

Definition at line 958 of file udp.c.

◆ udpDetachRxCallback()

error_t udpDetachRxCallback ( NetInterface interface,
uint16_t  port 
)

Unregister user callback.

Parameters
[in]interfaceUnderlying network interface
[in]portUDP port number
Returns
Error code

Definition at line 999 of file udp.c.

◆ udpDumpHeader()

void udpDumpHeader ( const UdpHeader datagram)

Dump UDP header for debugging purpose.

Parameters
[in]datagramPointer to the UDP header

Definition at line 1108 of file udp.c.

◆ udpGetDynamicPort()

uint16_t udpGetDynamicPort ( void  )

Get an ephemeral port number.

Returns
Ephemeral port

Definition at line 80 of file udp.c.

◆ udpInit()

error_t udpInit ( void  )

UDP related initialization.

Returns
Error code

Definition at line 62 of file udp.c.

◆ udpInvokeRxCallback()

error_t udpInvokeRxCallback ( NetInterface interface,
const IpPseudoHeader pseudoHeader,
const UdpHeader header,
const NetBuffer buffer,
size_t  offset,
const NetRxAncillary ancillary 
)

Invoke user callback.

Parameters
[in]interfaceUnderlying network interface
[in]pseudoHeaderUDP pseudo header
[in]headerUDP header
[in]bufferMulti-part buffer containing the payload
[in]offsetOffset to the first byte of the payload
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 1045 of file udp.c.

◆ udpProcessDatagram()

error_t udpProcessDatagram ( NetInterface interface,
const IpPseudoHeader pseudoHeader,
const NetBuffer buffer,
size_t  offset,
const NetRxAncillary ancillary 
)

Incoming UDP datagram processing.

Parameters
[in]interfaceUnderlying network interface
[in]pseudoHeaderUDP pseudo header
[in]bufferMulti-part buffer containing the incoming UDP datagram
[in]offsetOffset to the first byte of the UDP header
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 123 of file udp.c.

◆ udpReceiveDatagram()

error_t udpReceiveDatagram ( Socket socket,
SocketMsg message,
uint_t  flags 
)

Receive data from a UDP socket.

Parameters
[in]socketHandle referencing the socket
[out]messageReceived UDP datagram and ancillary data
[in]flagsSet of flags that influences the behavior of this function
Returns
Error code

Definition at line 780 of file udp.c.

◆ udpSendBuffer()

error_t udpSendBuffer ( NetInterface interface,
const IpAddr srcIpAddr,
uint16_t  srcPort,
const IpAddr destIpAddr,
uint16_t  destPort,
NetBuffer buffer,
size_t  offset,
NetTxAncillary ancillary 
)

Send a UDP datagram.

Parameters
[in]interfaceUnderlying network interface
[in]srcIpAddrSource IP address (optional parameter)
[in]srcPortSource port
[in]destIpAddrIP address of the target host
[in]destPortTarget port number
[in]bufferMulti-part buffer containing the payload
[in]offsetOffset to the first payload byte
[in]ancillaryAdditional options passed to the stack along with the packet
Returns
Error code

Definition at line 611 of file udp.c.

◆ udpSendDatagram()

error_t udpSendDatagram ( Socket socket,
const SocketMsg message,
uint_t  flags 
)

Send a UDP datagram.

Parameters
[in]socketHandle referencing the socket
[in]messagePointer to the structure describing the datagram
[in]flagsSet of flags that influences the behavior of this function
Returns
Error code

Definition at line 492 of file udp.c.

◆ udpUpdateEvents()

void udpUpdateEvents ( Socket socket)

Update UDP related events.

Parameters
[in]socketHandle referencing the socket

Definition at line 908 of file udp.c.

Variable Documentation

◆ __packed_struct

typedef __packed_struct
Initial value:
{
uint16_t srcPort

UDP header.

Definition at line 76 of file udp.h.

◆ checksum

uint16_t checksum

Definition at line 81 of file udp.h.

◆ data

uint8_t data[]

Definition at line 82 of file udp.h.

◆ destPort

uint16_t destPort

Definition at line 79 of file udp.h.

◆ length

uint16_t length

Definition at line 80 of file udp.h.

◆ udpCallbackTable

UdpRxCallbackEntry udpCallbackTable[UDP_CALLBACK_TABLE_SIZE]
extern

Definition at line 54 of file udp.c.

◆ UdpHeader

UdpHeader

Definition at line 83 of file udp.h.