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
struct {
char_t   type
uint32_t   dataStart
uint32_t   dataLength
uint8_t   nameLength
char_t   name []
uint8_t   tokenLen: 4
uint8_t   type: 2
uint8_t   version: 2
uint8_t   code
uint16_t   mid
uint8_t   token []
union {
uint8_t   b [6]
uint16_t   w [3]
}
uint16_t   srcPort
uint16_t   destPort
uint32_t   seqNum
uint32_t   ackNum
uint8_t   reserved1: 4
uint8_t   dataOffset: 4
uint8_t   flags: 6
uint8_t   reserved2: 2
uint16_t   window
uint16_t   checksum
uint16_t   urgentPointer
uint8_t   options []
uint16_t   length
uint8_t   data []
uint8_t   op
uint8_t   htype
uint8_t   hlen
uint8_t   hops
uint32_t   xid
uint16_t   secs
uint16_t   flags
Ipv4Addr   ciaddr
Ipv4Addr   yiaddr
Ipv4Addr   siaddr
Ipv4Addr   giaddr
MacAddr   chaddr
uint8_t   unused [10]
uint8_t   sname [64]
uint8_t   file [128]
uint32_t   magicCookie
uint16_t   type
uint16_t   hardwareType
uint32_t   time
MacAddr   linkLayerAddr
uint16_t   id
uint8_t   rd: 1
uint8_t   tc: 1
uint8_t   aa: 1
uint8_t   opcode: 4
uint8_t   qr: 1
uint8_t   rcode: 4
uint8_t   z: 3
uint8_t   ra: 1
uint16_t   qdcount
uint16_t   ancount
uint16_t   nscount
uint16_t   arcount
uint8_t   questions []
uint16_t   controlWord
uint16_t   byteCount
uint8_t   bLength
uint8_t   bDescriptorType
uint16_t   bcdUsb
uint8_t   bDeviceClass
uint8_t   bDeviceSubClass
uint8_t   bDeviceProtocol
uint8_t   bMaxPacketSize0
uint16_t   idVendor
uint16_t   idProduct
uint16_t   bcdDevice
uint8_t   iManufacturer
uint8_t   iProduct
uint8_t   iSerialNumber
uint8_t   bNumConfigurations
uint8_t   maxRespTime
Ipv4Addr   groupAddr
uint16_t   hrd
uint16_t   pro
uint8_t   hln
uint8_t   pln
uint16_t   op
MacAddr   sha
Ipv4Addr   spa
MacAddr   tha
Ipv4Addr   tpa
uint8_t   length
uint8_t   value []
uint16_t   first
uint16_t   last
uint16_t   next
union {
uint8_t   b [16]
uint16_t   w [8]
uint32_t   dw [4]
}
uint16_t   maxRespDelay
uint16_t   reserved
Ipv6Addr   multicastAddr
uint32_t   reserved
uint16_t   pvid
uint8_t   autoNegSupportStatus
uint16_t   pmdAutoNegAdvCap
uint16_t   operationalMauType
uint16_t   capabilities
uint8_t   deviceType
uint8_t   lengthH: 1
uint8_t   lengthL
uint8_t   t: 1
uint8_t   c: 1
union {
int32_t   integer
uint8_t   octetString [1]
uint8_t   oid [1]
uint8_t   ipAddr [4]
uint32_t   counter32
uint32_t   gauge32
uint32_t   unsigned32
uint32_t   timeTicks
uint64_t   counter64
}
uint16_t   transactionId
uint16_t   protocolId
uint8_t   unitId
uint8_t   pdu []
uint8_t   retain: 1
uint8_t   qos: 2
uint8_t   dup: 1
union {
uint8_t   all
struct {
uint8_t   topicIdType: 2
uint8_t   cleanSession: 1
uint8_t   will: 1
uint8_t   retain: 1
uint8_t   qos: 2
uint8_t   dup: 1
}
}
uint8_t   b: 1
uint8_t   identifier
uint8_t   valueSize
Ipv4Addr   srcIpAddr
Ipv4Addr   destIpAddr
Eui64   interfaceId
uint16_t   mru
uint8_t   peerIdLength
uint8_t   peerId []
uint32_t   seconds
uint32_t   fraction
uint16_t   opcode
char_t   filename []
uint8_t   reserved: 3
uint8_t   fin: 1
uint8_t   payloadLen: 7
uint8_t   mask: 1
uint8_t   extPayloadLen []
uint32_t   length
uint8_t   payload []
uint8_t   protocolVersionId
uint8_t   bpduType
StpBridgeId   rootId
uint32_t   rootPathCost
StpBridgeId   bridgeId
uint16_t   portId
uint16_t   messageAge
uint16_t   maxAge
uint16_t   helloTime
uint16_t   forwardDelay
uint8_t   version1Length
uint16_t   priority
MacAddr   addr
}	UdpHeader
	UDP header. More...
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, IpPseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, 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...
NetBuffer *	udpAllocBuffer (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, NetRxAncillary *ancillary)
	Invoke user callback. More...
void	udpDumpHeader (const UdpHeader *datagram)
	Dump UDP header for debugging purpose. More...

Variables
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.2.4

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

UdpHeader

typedef { ... } UdpHeader

UDP header.

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]	length	Desired payload length
[out]	offset	Offset 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 808 of file udp.c.

udpAttachRxCallback()

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

Register user callback.

Parameters

[in]	interface	Underlying network interface
[in]	port	UDP port number
[in]	callback	Callback function to be called when a datagram is received
[in]	param	Callback function parameter (optional)

Returns

Error code

Definition at line 877 of file udp.c.

udpDetachRxCallback()

error_t udpDetachRxCallback	(	NetInterface *	interface,
		uint16_t	port
	)

Unregister user callback.

Parameters

[in]	interface	Underlying network interface
[in]	port	UDP port number

Returns

Error code

Definition at line 918 of file udp.c.

udpDumpHeader()

void udpDumpHeader

(

const UdpHeader *

datagram

)

Dump UDP header for debugging purpose.

Parameters

[in]

datagram

Pointer to the UDP header

Definition at line 1027 of file udp.c.

udpGetDynamicPort()

uint16_t udpGetDynamicPort

(

void

)

Get an ephemeral port number.

Returns

Ephemeral port

Definition at line 81 of file udp.c.

udpInit()

error_t udpInit

(

void

)

UDP related initialization.

Returns

Error code

Definition at line 63 of file udp.c.

udpInvokeRxCallback()

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

Invoke user callback.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	UDP pseudo header
[in]	header	UDP header
[in]	buffer	Multi-part buffer containing the payload
[in]	offset	Offset to the first byte of the payload
[in]	ancillary	Additional options passed to the stack along with the packet

Returns

Error code

Definition at line 964 of file udp.c.

udpProcessDatagram()

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

Incoming UDP datagram processing.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	UDP pseudo header
[in]	buffer	Multi-part buffer containing the incoming UDP datagram
[in]	offset	Offset to the first byte of the UDP header
[in]	ancillary	Additional options passed to the stack along with the packet

Returns

Error code

Definition at line 124 of file udp.c.

udpReceiveDatagram()

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

Receive data from a UDP socket.

Parameters

[in]	socket	Handle referencing the socket
[out]	message	Received UDP datagram and ancillary data
[in]	flags	Set of flags that influences the behavior of this function

Returns

Error code

Definition at line 705 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]	interface	Underlying network interface
[in]	srcIpAddr	Source IP address (optional parameter)
[in]	srcPort	Source port
[in]	destIpAddr	IP address of the target host
[in]	destPort	Target port number
[in]	buffer	Multi-part buffer containing the payload
[in]	offset	Offset to the first payload byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns

Error code

Definition at line 548 of file udp.c.

udpSendDatagram()

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

Send a UDP datagram.

Parameters

[in]	socket	Handle referencing the socket
[in]	message	Pointer to the structure describing the datagram
[in]	flags	Set of flags that influences the behavior of this function

Returns

Error code

Definition at line 434 of file udp.c.

udpUpdateEvents()

void udpUpdateEvents

(

Socket *

socket

)

Update UDP related events.

Parameters

[in]

socket

Handle referencing the socket

Definition at line 831 of file udp.c.

Variable Documentation

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.

srcPort

uint16_t srcPort

Definition at line 78 of file udp.h.

udpCallbackTable

UdpRxCallbackEntry udpCallbackTable[UDP_CALLBACK_TABLE_SIZE]

extern

Definition at line 55 of file udp.c.