summaryrefslogtreecommitdiff
path: root/common/src/nx_igmp_info_get.c
blob: a0984ff178b7c20f4667a27aaeaac0fdf4fa495d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2025-present Eclipse ThreadX Contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** NetX Component                                                        */
/**                                                                       */
/**   Internet Group Management Protocol (IGMP)                           */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SOURCE_CODE


/* Include necessary system files.  */

#include "nx_api.h"
#include "nx_igmp.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_igmp_info_get                                   PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Yuxin Zhou, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function retrieves various IGMP information associated with    */
/*    the specified IP instance.                                          */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    ip_ptr                                IP instance pointer           */
/*    igmp_reports_sent                     Destination for the number    */
/*                                            of IGMP reports sent        */
/*    igmp_queries_received                 Destination for the number    */
/*                                            of IGMP queries received    */
/*    igmp_checksum_errors                  Destination for the number    */
/*                                            of IGMP checksum errors     */
/*    current_groups_joined                 Destination for the number    */
/*                                            of IGMP multicast groups    */
/*                                            currently joined            */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    tx_mutex_get                          Obtain protection mutex       */
/*    tx_mutex_put                          Release protection mutex      */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/**************************************************************************/
UINT  _nx_igmp_info_get(NX_IP *ip_ptr, ULONG *igmp_reports_sent, ULONG *igmp_queries_received,
                        ULONG *igmp_checksum_errors, ULONG *current_groups_joined)
{

#ifndef NX_DISABLE_IPV4


    /* If trace is enabled, insert this event into the trace buffer.  */
    NX_TRACE_IN_LINE_INSERT(NX_TRACE_IGMP_INFO_GET, ip_ptr, ip_ptr -> nx_ip_igmp_reports_sent, ip_ptr -> nx_ip_igmp_queries_received, ip_ptr -> nx_ip_igmp_groups_joined, NX_TRACE_IGMP_EVENTS, 0, 0);

    /* Obtain protection on this IP instance.  */
    tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);

    /* Determine if IGMP reports sent is wanted.  */
    if (igmp_reports_sent)
    {

        /* Return the number of IGMP reports sent by this IP instance.  */
        *igmp_reports_sent =  ip_ptr -> nx_ip_igmp_reports_sent;
    }

    /* Determine if IGMP queries received is wanted.  */
    if (igmp_queries_received)
    {

        /* Return the number of IGMP queries received by this IP instance.  */
        *igmp_queries_received =  ip_ptr -> nx_ip_igmp_queries_received;
    }

    /* Determine if IGMP checksum errors is wanted.  */
    if (igmp_checksum_errors)
    {

        /* Return the number of IGMP checksum errors by this IP instance.  */
        *igmp_checksum_errors =  ip_ptr -> nx_ip_igmp_checksum_errors;
    }

    /* Determine if the number of IGMP multicast groups joined is wanted.  */
    if (current_groups_joined)
    {

        /* Return the number of IGMP multicast groups joined is wanted.  */
        *current_groups_joined =  ip_ptr -> nx_ip_igmp_groups_joined;
    }

    /* Release the protection.  */
    tx_mutex_put(&(ip_ptr -> nx_ip_protection));

    /* Return a successful status!  */
    return(NX_SUCCESS);
#else /* NX_DISABLE_IPV4  */
    NX_PARAMETER_NOT_USED(ip_ptr);
    NX_PARAMETER_NOT_USED(igmp_reports_sent);
    NX_PARAMETER_NOT_USED(igmp_queries_received);
    NX_PARAMETER_NOT_USED(igmp_checksum_errors);
    NX_PARAMETER_NOT_USED(current_groups_joined);

    return(NX_NOT_SUPPORTED);
#endif /* !NX_DISABLE_IPV4  */
}