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 /** Internet Group Management Protocol (IGMP) */
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_igmp.h"
30
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _nx_igmp_multicast_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. */
46 /* */
47 /* INPUT */
48 /* */
49 /* ip_ptr IP instance pointer */
50 /* group_address Multicast group to join */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* NX_SUCCESS Successful completion status */
55 /* NX_ENTRY_NOT_FOUND Group address not found in the*/
56 /* IGMP join list */
57 /* */
58 /* CALLS */
59 /* */
60 /* _nx_igmp_multicast_interface_leave_internal */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
71 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_nx_igmp_multicast_leave(NX_IP * ip_ptr,ULONG group_address)75 UINT _nx_igmp_multicast_leave(NX_IP *ip_ptr, ULONG group_address)
76 {
77
78 #ifndef NX_DISABLE_IPV4
79 return(_nx_igmp_multicast_interface_leave_internal(ip_ptr, group_address, 0));
80 #else /* NX_DISABLE_IPV4 */
81 NX_PARAMETER_NOT_USED(ip_ptr);
82 NX_PARAMETER_NOT_USED(group_address);
83
84 return(NX_NOT_SUPPORTED);
85 #endif /* !NX_DISABLE_IPV4 */
86 }
87
88
