Documentation

embenet_udp.h File Reference

Table of contents Table of contents

embeNET UDP API More...

Data Structures
struct	EMBENET_UDP_SocketDescriptor
	Structure describing an UDP Socket. More...

Typedefs
typedef struct EMBENET_UDP_SocketDescriptor	EMBENET_UDP_SocketDescriptor

typedef void(*	EMBENET_UDP_RxDataHandler) (EMBENET_UDP_SocketDescriptor const socket, EMBENET_IPV6 const sourceAddress, uint16_t sourcePort, void const *data, size_t dataSize)
	Data reception handler that is called every time some data on a certain registered port is received. More...

Enumerations
enum	EMBENET_UDP_Traffic { EMBENET_UDP_TRAFFIC_UNICAST = 0 , EMBENET_UDP_TRAFFIC_MULTICAST = 1 , EMBENET_UDP_TRAFFIC_ALL = 2 }

Functions
EMBENET_Result	EMBENET_UDP_RegisterSocket (EMBENET_UDP_SocketDescriptor *socket)
	Registers a new UDP socket. More...

EMBENET_Result	EMBENET_UDP_UnregisterSocket (EMBENET_UDP_SocketDescriptor *socket)
	Unregisters socket from interface. More...

size_t	EMBENET_UDP_GetMaxDataSize (EMBENET_UDP_SocketDescriptor const *socket)
	Gets the maximum size of a single UDP payload size. More...

EMBENET_Result	EMBENET_UDP_Send (EMBENET_UDP_SocketDescriptor const socket, EMBENET_IPV6 const destinationAddress, uint16_t destinationPort, const void *data, size_t dataSize)
	Sends UDP datagram from the given socket. More...

Detailed Description

embeNET UDP API

License: Commercial

Copyright: (c) 2023 EMBETECH SP. Z O.O. All rights reserved.

Version: 1.0.3624

Purpose: embeNET UDP API