2ba9af4ffaad45e5b617325d6181f0aabe6593bd
[folly.git] / folly / io / async / EventUtil.h
1 /*
2  * Copyright 2017 Facebook, Inc.
3  *
4  * Licensed to the Apache Software Foundation (ASF) under one
5  * or more contributor license agreements. See the NOTICE file
6  * distributed with this work for additional information
7  * regarding copyright ownership. The ASF licenses this file
8  * to you under the Apache License, Version 2.0 (the
9  * "License"); you may not use this file except in compliance
10  * with the License. You may obtain a copy of the License at
11  *
12  *   http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing,
15  * software distributed under the License is distributed on an
16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17  * KIND, either express or implied. See the License for the
18  * specific language governing permissions and limitations
19  * under the License.
20  */
21 #pragma once
22
23 #include <functional>
24
25 #include <folly/portability/Event.h>
26
27 namespace folly {
28
29 # if LIBEVENT_VERSION_NUMBER <= 0x02010101
30 #   define FOLLY_LIBEVENT_COMPAT_PLUCK(name) ev_##name
31 # else
32 #   define FOLLY_LIBEVENT_COMPAT_PLUCK(name) ev_evcallback.evcb_##name
33 # endif
34 # define FOLLY_LIBEVENT_DEF_ACCESSORS(name) \
35     inline auto event_ref_##name(struct event* ev) -> \
36       decltype(std::ref(ev->FOLLY_LIBEVENT_COMPAT_PLUCK(name))) \
37       { return std::ref(ev->FOLLY_LIBEVENT_COMPAT_PLUCK(name)); } \
38     inline auto event_ref_##name(struct event const* ev) -> \
39       decltype(std::cref(ev->FOLLY_LIBEVENT_COMPAT_PLUCK(name))) \
40       { return std::cref(ev->FOLLY_LIBEVENT_COMPAT_PLUCK(name)); } \
41     //
42
43 FOLLY_LIBEVENT_DEF_ACCESSORS(flags)
44
45 # undef FOLLY_LIBEVENT_COMPAT_PLUCK
46 # undef FOLLY_LIBEVENT_DEF_ACCESSORS
47
48 /**
49  * low-level libevent utility functions
50  */
51 class EventUtil {
52  public:
53   static bool isEventRegistered(const struct event* ev) {
54     // If any of these flags are set, the event is registered.
55     enum {
56       EVLIST_REGISTERED = (EVLIST_INSERTED | EVLIST_ACTIVE |
57                            EVLIST_TIMEOUT | EVLIST_SIGNAL)
58     };
59     return (event_ref_flags(ev) & EVLIST_REGISTERED);
60   }
61 };
62
63 } // folly