1 /*************************************************************************** 2 * Copyright (c) 2024 Microsoft Corporation 3 * 4 * This program and the accompanying materials are made available under the 5 * terms of the MIT License which is available at 6 * https://opensource.org/licenses/MIT. 7 * 8 * SPDX-License-Identifier: MIT 9 **************************************************************************/ 10 11 12 /**************************************************************************/ 13 /**************************************************************************/ 14 /** */ 15 /** NetX Component */ 16 /** */ 17 /** Internet Group Management Protocol (IGMP) */ 18 /** */ 19 /**************************************************************************/ 20 /**************************************************************************/ 21 22 #define NX_SOURCE_CODE 23 24 25 /* Include necessary system files. */ 26 27 #include "nx_api.h" 28 #include "nx_ip.h" 29 #include "nx_igmp.h" 30 31 32 /**************************************************************************/ 33 /* */ 34 /* FUNCTION RELEASE */ 35 /* */ 36 /* _nx_ipv4_multicast_interface_leave PORTABLE C */ 37 /* 6.1 */ 38 /* AUTHOR */ 39 /* */ 40 /* Yuxin Zhou, Microsoft Corporation */ 41 /* */ 42 /* DESCRIPTION */ 43 /* */ 44 /* This function handles the request to leave the specified multicast */ 45 /* group on a specified network device. */ 46 /* */ 47 /* INPUT */ 48 /* */ 49 /* ip_ptr IP instance pointer */ 50 /* group_address Multicast group to join */ 51 /* interface_index Index to the interface */ 52 /* */ 53 /* OUTPUT */ 54 /* */ 55 /* status Completion status */ 56 /* */ 57 /* CALLS */ 58 /* */ 59 /* _nx_igmp_multicast_interface_leave_internal */ 60 /* */ 61 /* CALLED BY */ 62 /* */ 63 /* Application Code */ 64 /* */ 65 /* RELEASE HISTORY */ 66 /* */ 67 /* DATE NAME DESCRIPTION */ 68 /* */ 69 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */ 70 /* 09-30-2020 Yuxin Zhou Modified comment(s), */ 71 /* resulting in version 6.1 */ 72 /* */ 73 /**************************************************************************/ _nx_ipv4_multicast_interface_leave(NX_IP * ip_ptr,ULONG group_address,UINT interface_index)74UINT _nx_ipv4_multicast_interface_leave(NX_IP *ip_ptr, ULONG group_address, UINT interface_index) 75 { 76 77 #ifndef NX_DISABLE_IPV4 78 return(_nx_igmp_multicast_interface_leave_internal(ip_ptr, group_address, interface_index)); 79 80 #else /* NX_DISABLE_IPV4 */ 81 NX_PARAMETER_NOT_USED(ip_ptr); 82 NX_PARAMETER_NOT_USED(group_address); 83 NX_PARAMETER_NOT_USED(interface_index); 84 85 return(NX_NOT_SUPPORTED); 86 #endif /* !NX_DISABLE_IPV4 */ 87 } 88 89
