1 /**************************************************************************/ 2 /* */ 3 /* Copyright (c) Microsoft Corporation. All rights reserved. */ 4 /* */ 5 /* This software is licensed under the Microsoft Software License */ 6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */ 7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ 8 /* and in the root directory of this software. */ 9 /* */ 10 /**************************************************************************/ 11 12 13 /**************************************************************************/ 14 /**************************************************************************/ 15 /** */ 16 /** NetX Component */ 17 /** */ 18 /** User Datagram Protocol (UDP) */ 19 /** */ 20 /**************************************************************************/ 21 /**************************************************************************/ 22 23 #define NX_SOURCE_CODE 24 25 26 /* Include necessary system files. */ 27 28 #include "nx_api.h" 29 #include "nx_udp.h" 30 31 32 /* Bring in externs for caller checking code. */ 33 34 NX_CALLER_CHECKING_EXTERNS 35 36 37 /**************************************************************************/ 38 /* */ 39 /* FUNCTION RELEASE */ 40 /* */ 41 /* _nxe_udp_socket_bytes_available PORTABLE C */ 42 /* 6.1 */ 43 /* AUTHOR */ 44 /* */ 45 /* Yuxin Zhou, Microsoft Corporation */ 46 /* */ 47 /* DESCRIPTION */ 48 /* */ 49 /* This function checks for errors in the UDP socket bytes */ 50 /* available function call. */ 51 /* */ 52 /* INPUT */ 53 /* */ 54 /* socket_ptr Pointer to socket */ 55 /* bytes_available Pointer to bytes available */ 56 /* */ 57 /* OUTPUT */ 58 /* */ 59 /* status Completion status */ 60 /* */ 61 /* CALLS */ 62 /* */ 63 /* _nx_udp_socket_bytes_available Actual UDP socket bytes */ 64 /* available function */ 65 /* */ 66 /* CALLED BY */ 67 /* */ 68 /* Application */ 69 /* */ 70 /* RELEASE HISTORY */ 71 /* */ 72 /* DATE NAME DESCRIPTION */ 73 /* */ 74 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */ 75 /* 09-30-2020 Yuxin Zhou Modified comment(s), */ 76 /* resulting in version 6.1 */ 77 /* */ 78 /**************************************************************************/ _nxe_udp_socket_bytes_available(NX_UDP_SOCKET * socket_ptr,ULONG * bytes_available)79UINT _nxe_udp_socket_bytes_available(NX_UDP_SOCKET *socket_ptr, ULONG *bytes_available) 80 { 81 82 UINT status; 83 84 85 /* Check for invalid input pointers. */ 86 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_udp_socket_id != NX_UDP_ID) || (bytes_available == NX_NULL)) 87 { 88 return(NX_PTR_ERROR); 89 } 90 91 /* Check to see if UDP is enabled. */ 92 if (!(socket_ptr -> nx_udp_socket_ip_ptr) -> nx_ip_udp_packet_receive) 93 { 94 return(NX_NOT_ENABLED); 95 } 96 97 /* Check for appropriate caller. */ 98 NX_THREADS_ONLY_CALLER_CHECKING 99 100 /* Call actual UDP socket receive function. */ 101 status = _nx_udp_socket_bytes_available(socket_ptr, bytes_available); 102 103 /* Return completion status. */ 104 return(status); 105 } 106 107
