aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/core/lib/iomgr/polling_entity.h
blob: 971fd88b428fdb4844a10a05daa67ca57f757015 (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
/*
 *
 * Copyright 2015 gRPC authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef GRPC_CORE_LIB_IOMGR_POLLING_ENTITY_H
#define GRPC_CORE_LIB_IOMGR_POLLING_ENTITY_H

#include "src/core/lib/iomgr/pollset.h"
#include "src/core/lib/iomgr/pollset_set.h"

/* A grpc_polling_entity is a pollset-or-pollset_set container. It allows
 * functions that accept a pollset XOR a pollset_set to do so through an
 * abstract interface. No ownership is taken. */

typedef struct grpc_polling_entity {
  union {
    grpc_pollset *pollset;
    grpc_pollset_set *pollset_set;
  } pollent;
  enum pops_tag { POPS_NONE, POPS_POLLSET, POPS_POLLSET_SET } tag;
} grpc_polling_entity;

grpc_polling_entity grpc_polling_entity_create_from_pollset_set(
    grpc_pollset_set *pollset_set);
grpc_polling_entity grpc_polling_entity_create_from_pollset(
    grpc_pollset *pollset);

/** If \a pollent contains a pollset, return it. Otherwise, return NULL */
grpc_pollset *grpc_polling_entity_pollset(grpc_polling_entity *pollent);

/** If \a pollent contains a pollset_set, return it. Otherwise, return NULL */
grpc_pollset_set *grpc_polling_entity_pollset_set(grpc_polling_entity *pollent);

bool grpc_polling_entity_is_empty(const grpc_polling_entity *pollent);

/** Add the pollset or pollset_set in \a pollent to the destination pollset_set
 * \a * pss_dst */
void grpc_polling_entity_add_to_pollset_set(grpc_exec_ctx *exec_ctx,
                                            grpc_polling_entity *pollent,
                                            grpc_pollset_set *pss_dst);

/** Delete the pollset or pollset_set in \a pollent from the destination
 * pollset_set \a * pss_dst */
void grpc_polling_entity_del_from_pollset_set(grpc_exec_ctx *exec_ctx,
                                              grpc_polling_entity *pollent,
                                              grpc_pollset_set *pss_dst);
#endif /* GRPC_CORE_LIB_IOMGR_POLLING_ENTITY_H */