xref: /aosp_15_r20/external/grpc-grpc/src/python/grpcio/grpc/_cython/_cygrpc/channelz.pyx.pxi (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2) 
1# Copyright 2018 The gRPC Authors
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#     http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15
16def channelz_get_top_channels(start_channel_id):
17    cdef char *c_returned_str = grpc_channelz_get_top_channels(
18        start_channel_id,
19    )
20    if c_returned_str == NULL:
21        raise ValueError('Failed to get top channels, please ensure your' \
22                         ' start_channel_id==%s is valid' % start_channel_id)
23    return c_returned_str
24
25def channelz_get_servers(start_server_id):
26    cdef char *c_returned_str = grpc_channelz_get_servers(start_server_id)
27    if c_returned_str == NULL:
28        raise ValueError('Failed to get servers, please ensure your' \
29                         ' start_server_id==%s is valid' % start_server_id)
30    return c_returned_str
31
32def channelz_get_server(server_id):
33    cdef char *c_returned_str = grpc_channelz_get_server(server_id)
34    if c_returned_str == NULL:
35        raise ValueError('Failed to get the server, please ensure your' \
36                         ' server_id==%s is valid' % server_id)
37    return c_returned_str
38
39def channelz_get_server_sockets(server_id, start_socket_id, max_results):
40    cdef char *c_returned_str = grpc_channelz_get_server_sockets(
41        server_id,
42        start_socket_id,
43        max_results,
44    )
45    if c_returned_str == NULL:
46        raise ValueError('Failed to get server sockets, please ensure your' \
47                         ' server_id==%s and start_socket_id==%s and' \
48                         ' max_results==%s is valid' %
49                         (server_id, start_socket_id, max_results))
50    return c_returned_str
51
52def channelz_get_channel(channel_id):
53    cdef char *c_returned_str = grpc_channelz_get_channel(channel_id)
54    if c_returned_str == NULL:
55        raise ValueError('Failed to get the channel, please ensure your' \
56                         ' channel_id==%s is valid' % (channel_id))
57    return c_returned_str
58
59def channelz_get_subchannel(subchannel_id):
60    cdef char *c_returned_str = grpc_channelz_get_subchannel(subchannel_id)
61    if c_returned_str == NULL:
62        raise ValueError('Failed to get the subchannel, please ensure your' \
63                         ' subchannel_id==%s is valid' % (subchannel_id))
64    return c_returned_str
65
66def channelz_get_socket(socket_id):
67    cdef char *c_returned_str = grpc_channelz_get_socket(socket_id)
68    if c_returned_str == NULL:
69        raise ValueError('Failed to get the socket, please ensure your' \
70                         ' socket_id==%s is valid' % (socket_id))
71    return c_returned_str
72