oc_udp.h

Go to the documentation of this file.

#ifndef SYSTEM_CORE_INC_NET_PROTOCOLS_UDP_OC_UDP_H_
#define SYSTEM_CORE_INC_NET_PROTOCOLS_UDP_OC_UDP_H_

#include <oc_net.h>
#include <oc_netif.h>
#include <limits.h>
#include <oc_process.h>

#define _________________________________________DEFINITIONS_SECTION________________________________________________________________________

#undef  _________________________________________DEFINITIONS_SECTION________________________________________________________________________


#define _________________________________________TYPES_SECTION_____________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_Udp_Port_Empty                   = 0 ,                       
    oC_Udp_Port_MAX                     = UINT16_MAX ,              

    // ==================== WELL KNOWN PORTS ==================== //
    oC_Udp_Port_TCPMUX                          = 1  , 
    oC_Udp_Port_RemoteJobEntry                  = 5  , 
    oC_Udp_Port_Echo                            = 7  , 
    oC_Udp_Port_Daytime                         = 13 , 
    oC_Udp_Port_QuoteOfTheDay                   = 17 , 
    oC_Udp_Port_MessageSend                     = 18 , 
    oC_Udp_Port_CHARGEN                         = 19 , 
    oC_Udp_Port_FTP                             = 20 , 
    oC_Udp_Port_Telnet                          = 23 , 
    oC_Udp_Port_SMTP                            = 25 , 
    oC_Udp_Port_Time                            = 37 , 
    oC_Udp_Port_RAP                             = 38 , 
    oC_Udp_Port_RLP                             = 39 , 
    oC_Udp_Port_HostNameServer                  = 42 , 
    oC_Udp_Port_WHOIS                           = 43 , 
    oC_Udp_Port_TACACS                          = 49 , 
    oC_Udp_Port_RemoteMailChecking              = 50 , 
    oC_Udp_Port_XNSTime                         = 52 , 
    oC_Udp_Port_DNS                             = 53 , 
    oC_Udp_Port_XNSClearingHouse                = 54 , 
    oC_Udp_Port_XNSAuthentication               = 56 , 
    oC_Udp_Port_AnyPrivateTerminalAccess        = 57 , 
    oC_Udp_Port_XNSMail                         = 58 , 
    oC_Udp_Port_BOOTPServer                     = 67 , 
    oC_Udp_Port_BOOTPClient                     = 68 , 
    oC_Udp_Port_TFTP                            = 69 , 
    oC_Udp_Port_Gopher                          = 70 , 
    oC_Udp_Port_NETRJS                          = 74 , 
    oC_Udp_Port_AnyPrivateDialOutService        = 75 , 
    oC_Udp_Port_AnyPrivateRemoteJobEntry        = 77 , 
    oC_Udp_Port_Finger                          = 79 , 
    oC_Udp_Port_KerberosAuthenticationSystem    = 88 , 
    oC_Udp_Port_DNSIX                           = 90 , 
    oC_Udp_Port_NICHostName                     = 101 , 
    oC_Udp_Port_TSAP                            = 102 , 
    oC_Udp_Port_DICOM                           = 104 , 
    oC_Udp_Port_CCSONameserver                  = 105 , 
    oC_Udp_Port_RTelnet                         = 107 , 
    oC_Udp_Port_SNA                             = 108 , 
    oC_Udp_Port_POP2                            = 109 , 
    oC_Udp_Port_POP3                            = 110 , 
    oC_Udp_Port_OncRpc                          = 111 , 
    oC_Udp_Port_Auth                            = 113 , 
    oC_Udp_Port_SFTP                            = 115 , 
    oC_Udp_Port_UUCPMappingProject              = 117 , 
    oC_Udp_Port_SQLServices                     = 118 , 
    oC_Udp_Port_NNTP                            = 119 , 
    oC_Udp_Port_NTP                             = 123 , 
    oC_Udp_Port_FormerlyUnisysUnitaryLogin      = 126 , 
    oC_Udp_Port_DCEEndpointResolution           = 135 , 
    oC_Udp_Port_MicrosoftEPMAP                  = 135 , 
    oC_Udp_Port_NetBIOS                         = 137 , 
    oC_Udp_Port_NetBIOSDatagram                 = 138 , 
    oC_Udp_Port_NetBIOSSession                  = 139 , 
    oC_Udp_Port_IMAP                            = 143 , 
    oC_Udp_Port_BFTP                            = 152 , 
    oC_Udp_Port_SGMP                            = 153 , 
    oC_Udp_Port_SQL                             = 156 , 
    oC_Udp_Port_DMSP                            = 158 , 
    oC_Udp_Port_SNMP                            = 161 , 
    oC_Udp_Port_SNMPTRAP                        = 162 , 
    oC_Udp_Port_PrintServer                     = 170 , 
    oC_Udp_Port_XDMCP                           = 177 , 
    oC_Udp_Port_IRC                             = 194 , 
    oC_Udp_Port_SMUX                            = 199 , 
    oC_Udp_Port_AppleTalkRoutingMaintenance     = 201 , 
    oC_Udp_Port_QuickMailTransferProtocol       = 209 , 
    oC_Udp_Port_ANSIZ39_50                      = 210 , 
    oC_Udp_Port_IPX                             = 213 , 
    oC_Udp_Port_MPP                             = 218 , 
    oC_Udp_Port_IMAPVer3                        = 220 , 
    oC_Udp_Port_ESRO                            = 259 , 
    oC_Udp_Port_Arcisdms                        = 262 , 
    oC_Udp_Port_BGMP                            = 264 , 
    oC_Udp_Port_http_mgmt                       = 280 , 
    oC_Udp_Port_TSP                             = 318 , 
    oC_Udp_Port_PTPEvent                        = 319 , 
    oC_Udp_Port_PTPGeneral                      = 320 , 
    oC_Udp_Port_MATIP                           = 350 , 
    oC_Udp_Port_MATIPTypeB                      = 351 , 
    oC_Udp_Port_Cloanto_net_1                   = 356 , 
    oC_Udp_Port_ODMR                            = 366 , 
    oC_Udp_Port_Rpc2portmap                     = 369 , 
    oC_Udp_Port_CodaAuth2                       = 370 , 
    oC_Udp_Port_SecureCast1                     = 370 , 
    oC_Udp_Port_ClearCaseAlbd                   = 371 , 
    oC_Udp_Port_HPDataAlarmManager              = 383 , 
    oC_Udp_Port_ARemoteNetworkServerSystem      = 384 , 
    oC_Udp_Port_AURP                            = 387 , 
    oC_Udp_Port_LDAP                            = 389 , 
    oC_Udp_Port_DigitalEquipmentCorporationDEC  = 399 , 
    oC_Udp_Port_UPS                             = 401 , 
    oC_Udp_Port_SLP                             = 427 , 
    oC_Udp_Port_NNSP                            = 433 , 
    oC_Udp_Port_MobileIpAgent                   = 434 , 
    oC_Udp_Port_SNPP                            = 444 , 
    oC_Udp_Port_KerberosChangeSetPassword       = 464 , 
    oC_Udp_Port_TcpNetHaspsrv                   = 475 , 
    oC_Udp_Port_ISAKMP                          = 500 , 
    oC_Udp_Port_Modbus                          = 502 , 
    oC_Udp_Port_Citadel                         = 504 , 
    oC_Udp_Port_FCP                             = 510 , 
    oC_Udp_Port_ComSat                          = 512 , 
    oC_Udp_Port_Who                             = 513 , 
    oC_Udp_Port_Syslog                          = 514 , 
    oC_Udp_Port_Talk                            = 517 , 
    oC_Udp_Port_NTalk                           = 518 , 
    oC_Udp_Port_RIP                             = 520 , 
    oC_Udp_Port_RIPng                           = 521 , 
    oC_Udp_Port_NCP                             = 524 , 
    oC_Udp_Port_TimedTimeserver                 = 525 , 
    oC_Udp_Port_RPC                             = 530 , 
    oC_Udp_Port_NetwallForEmergencyBroadcasts   = 533 , 
    oC_Udp_Port_Commerce                        = 542 , 
    oC_Udp_Port_DHCPv6Client                    = 546 , 
    oC_Udp_Port_DHCPv6Server                    = 547 , 
    oC_Udp_Port_NewRwhoNewWho                   = 550 , 
    oC_Udp_Port_RTSP                            = 554 , 
    oC_Udp_Port_RMonitorRemoteMonitor           = 560 , 
    oC_Udp_Port_Monitor                         = 561 , 
    oC_Udp_Port_NNTPS                           = 563 , 
    oC_Udp_Port_HTTP                            = 593 , 
    oC_Udp_Port_ASFRemoteManagementAndControl   = 623 , 
    oC_Udp_Port_IPP                             = 631 , 
    oC_Udp_Port_RLZDBase                        = 635 , 
    oC_Udp_Port_LDAPS                           = 636 , 
    oC_Udp_Port_MSDPMulticastSourceDiscovery    = 639 , 
    oC_Udp_Port_SupportSoftNexusRemoteControl   = 641 , 
    oC_Udp_Port_SANity                          = 643 , 
    oC_Udp_Port_LDP                             = 646 , 
    oC_Udp_Port_IEEE_MMS                        = 651 , 
    oC_Udp_Port_SupportSoftNexusRemoteData      = 653 , 
    oC_Udp_Port_TincVPNDaemon                   = 655 , 
    oC_Udp_Port_IBMRMC                          = 657 , 
    oC_Udp_Port_Doom                            = 666 , 
    oC_Udp_Port_REALM_RUSD                      = 688 , 
    oC_Udp_Port_VATP                            = 690 , 
    oC_Udp_Port_Linux                           = 694 , 
    oC_Udp_Port_OLSR                            = 698 , 
    oC_Udp_Port_Kerberos                        = 749 , 
    oC_Udp_Port_kerberos_IvKerberosVersionIV    = 750 , 
    oC_Udp_Port_RRH                             = 753 , 
    oC_Udp_Port_TellSend                        = 754 , 
    oC_Udp_Port_mdbs_daemon                     = 800 , 
    oC_Udp_Port_NETCONFOverSSH                  = 830 , 
    oC_Udp_Port_NETCONFOverBEEP                 = 831 , 
    oC_Udp_Port_NETCONFHTTPS                    = 832 , 
    oC_Udp_Port_NETCONFBEEP                     = 833 , 
    oC_Udp_Port_GDOI                            = 848 , 
    oC_Udp_Port_DNSOverTLS                      = 853 , 
    oC_Udp_Port_OWAMP                           = 861 , 
    oC_Udp_Port_TWAMP                           = 862 , 
    oC_Udp_Port_FTPSData                        = 989 , 
    oC_Udp_Port_FTPSControl                     = 990 , 
    oC_Udp_Port_NAS                             = 991 , 
    oC_Udp_Port_TelnetOverTLS_SSL               = 992 , 

    oC_Udp_Port_NumberOfSpecialPorts            = 1024 ,

} oC_Udp_Port_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct PACKED
{
#if defined(LITTLE_ENDIAN)
    uint16_t            SourcePort;         
    uint16_t            DestinationPort;    
    uint16_t            Length;             
    uint16_t            Checksum;           
#elif defined(BIG_ENDIAN)
#   error oC_Udp_Header_t structure is not defined for BIG ENDIAN!
#else
#   error Unknown endianess
#endif
} oC_Udp_Header_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef union PACKED
{
    struct
    {
        oC_Net_Ipv4_t       SourceIp;
        oC_Net_Ipv4_t       DestinationIp;
        uint8_t             Zeroes;
        uint8_t             Protocol;
        uint16_t            UdpLength;
        uint16_t            SourcePort;
        uint16_t            DestinationPort;
        uint16_t            Length;
        uint16_t            Checksum;
        uint32_t            Data[2];
    } IPv4;

    struct
    {
        uint8_t             IPv6IsNotDefinedYet;
    } IPv6;
} oC_Udp_PseudoHeader_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct PACKED
{
    oC_Udp_Header_t     Header;         
    uint8_t             Data[4];        
} oC_Udp_Datagram_t ;

//==========================================================================================================================================
//==========================================================================================================================================
typedef union
{
    oC_Net_Packet_t     Packet;

    struct
    {
        oC_Net_Ipv4PacketHeader_t   Header;
        oC_Udp_Datagram_t           UdpDatagram;
    } IPv4;

    struct
    {
        oC_Net_Ipv6PacketHeader_t   Header;
        oC_Udp_Datagram_t           UdpDatagram;
    } IPv6;
} oC_Udp_Packet_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct Udp_t * oC_Udp_t;

#undef  _________________________________________TYPES_SECTION_____________________________________________________________________________

#define _________________________________________PROTOTYPES_SECTION_________________________________________________________________________

extern oC_ErrorCode_t   oC_Udp_TurnOn                       ( void );
extern oC_ErrorCode_t   oC_Udp_TurnOff                      ( void );
extern bool             oC_Udp_IsPortReserved               ( oC_Udp_Port_t Port , oC_Process_t Process );
extern oC_ErrorCode_t   oC_Udp_ReservePort                  ( oC_Udp_Port_t * Port , oC_Time_t Timeout );
extern oC_ErrorCode_t   oC_Udp_ReleasePort                  ( oC_Udp_Port_t Port , oC_Time_t Timeout );
extern oC_ErrorCode_t   oC_Udp_ReleaseAllPortsReservedBy    ( oC_Process_t Process , oC_Time_t Timeout );
extern uint16_t         oC_Udp_Packet_GetMaximumDataSize    ( oC_Net_PacketType_t Type );
extern oC_Udp_Packet_t* oC_Udp_Packet_New                   ( Allocator_t PacketAllocator , oC_Net_PacketType_t Type , const void * Data , uint16_t Size );
extern bool             oC_Udp_Packet_Delete                ( oC_Udp_Packet_t ** Packet );
extern uint16_t         oC_Udp_Packet_GetDataSize           ( const oC_Udp_Packet_t * Packet );
extern bool             oC_Udp_Packet_SetData               ( oC_Udp_Packet_t * Packet , const void * Data , uint16_t Size );
extern oC_ErrorCode_t   oC_Udp_Packet_ReadData              ( const oC_Udp_Packet_t * Packet , void * outData , uint16_t Size );
extern void *           oC_Udp_Packet_GetDataReference      ( oC_Udp_Packet_t * Packet );
extern oC_ErrorCode_t   oC_Udp_Send                         ( oC_Netif_t Netif , oC_Udp_Port_t LocalPort , const oC_Net_Address_t * Destination, oC_Udp_Packet_t * Packet , oC_Time_t Timeout );
extern oC_ErrorCode_t   oC_Udp_Receive                      ( oC_Netif_t Netif , oC_Udp_Port_t LocalPort , oC_Udp_Packet_t * Packet , oC_Time_t Timeout );
extern oC_ErrorCode_t   oC_Udp_CalculateChecksum            ( oC_Udp_Packet_t * Packet , bool * outChecksumCorrect , uint16_t * outExpectedChecksum );

#undef  _________________________________________PROTOTYPES_SECTION_________________________________________________________________________


#endif /* SYSTEM_CORE_INC_NET_PROTOCOLS_UDP_OC_UDP_H_ */