udp.c File Reference

UDP (User Datagram Protocol) More...

#include <string.h>
#include "core/net.h"
#include "core/ip.h"
#include "core/udp.h"
#include "core/socket.h"
#include "ipv4/ipv4.h"
#include "ipv6/ipv6.h"
#include "ipv6/ipv6_misc.h"
#include "mibs/mib2_module.h"
#include "mibs/udp_mib_module.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   UDP_TRACE_LEVEL
 

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)
 Incoming UDP datagram processing. More...
 
error_t udpSendDatagram (Socket *socket, const IpAddr *destIpAddr, uint16_t destPort, const void *data, size_t length, size_t *written)
 Send a UDP datagram. More...
 
error_t udpSendDatagramEx (NetInterface *interface, uint16_t srcPort, const IpAddr *destIpAddr, uint16_t destPort, NetBuffer *buffer, size_t offset, uint8_t ttl)
 Send a UDP datagram (raw interface) More...
 
error_t udpReceiveDatagram (Socket *socket, IpAddr *srcIpAddr, uint16_t *srcPort, IpAddr *destIpAddr, void *data, size_t size, size_t *received, 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)
 Invoke user callback. More...
 
void udpDumpHeader (const UdpHeader *datagram)
 Dump UDP header for debugging purpose. More...
 

Variables

OsMutex udpCallbackMutex
 
UdpRxCallbackDesc udpCallbackTable [UDP_CALLBACK_TABLE_SIZE]
 

Detailed Description

UDP (User Datagram Protocol)

License

Copyright (C) 2010-2018 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
1.9.0

Definition in file udp.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   UDP_TRACE_LEVEL

Definition at line 30 of file udp.c.

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 656 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 723 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 770 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 900 of file udp.c.

◆ udpGetDynamicPort()

uint16_t udpGetDynamicPort ( void  )

Get an ephemeral port number.

Returns
Ephemeral port

Definition at line 86 of file udp.c.

◆ udpInit()

error_t udpInit ( void  )

UDP related initialization.

Returns
Error code

Definition at line 61 of file udp.c.

◆ udpInvokeRxCallback()

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

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
Returns
Error code

Definition at line 820 of file udp.c.

◆ udpProcessDatagram()

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

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
Returns
Error code

Definition at line 127 of file udp.c.

◆ udpReceiveDatagram()

error_t udpReceiveDatagram ( Socket socket,
IpAddr srcIpAddr,
uint16_t *  srcPort,
IpAddr destIpAddr,
void *  data,
size_t  size,
size_t *  received,
uint_t  flags 
)

Receive data from a UDP socket.

Parameters
[in]socketHandle referencing the socket
[out]srcIpAddrSource IP address (optional)
[out]srcPortSource port number (optional)
[out]destIpAddrDestination IP address (optional)
[out]dataBuffer where to store the incoming data
[in]sizeMaximum number of bytes that can be received
[out]receivedNumber of bytes that have been received
[in]flagsSet of flags that influences the behavior of this function
Returns
Error code

Definition at line 581 of file udp.c.

◆ udpSendDatagram()

error_t udpSendDatagram ( Socket socket,
const IpAddr destIpAddr,
uint16_t  destPort,
const void *  data,
size_t  length,
size_t *  written 
)

Send a UDP datagram.

Parameters
[in]socketHandle referencing the socket
[in]destIpAddrIP address of the target host
[in]destPortTarget port number
[in]dataPointer to data payload
[in]lengthLength of the payload data
[out]writtenActual number of bytes written (optional parameter)
Returns
Error code

Definition at line 397 of file udp.c.

◆ udpSendDatagramEx()

error_t udpSendDatagramEx ( NetInterface interface,
uint16_t  srcPort,
const IpAddr destIpAddr,
uint16_t  destPort,
NetBuffer buffer,
size_t  offset,
uint8_t  ttl 
)

Send a UDP datagram (raw interface)

Parameters
[in]interfaceUnderlying network interface
[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]ttlTTL value. Default Time-To-Live is used when this parameter is zero
Returns
Error code

Definition at line 448 of file udp.c.

◆ udpUpdateEvents()

void udpUpdateEvents ( Socket socket)

Update UDP related events.

Parameters
[in]socketHandle referencing the socket

Definition at line 679 of file udp.c.

Variable Documentation

◆ udpCallbackMutex

OsMutex udpCallbackMutex

Definition at line 51 of file udp.c.

◆ udpCallbackTable

Definition at line 53 of file udp.c.