2 * Copyright 2017 Facebook, Inc.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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
23 #include <glog/logging.h>
24 #include <folly/io/async/EventUtil.h>
25 #include <folly/portability/Event.h>
26 #include <boost/noncopyable.hpp>
34 * The EventHandler class is used to asynchronously wait for events on a file
37 * Users that wish to wait on I/O events should derive from EventHandler and
38 * implement the handlerReady() method.
40 class EventHandler : private boost::noncopyable {
46 READ_WRITE = (READ | WRITE),
48 // Temporary flag until EPOLLPRI is upstream on libevent.
55 * Create a new EventHandler object.
57 * @param eventBase The EventBase to use to drive this event handler.
58 * This may be nullptr, in which case the EventBase must be
59 * set separately using initHandler() or attachEventBase()
60 * before the handler can be registered.
61 * @param fd The file descriptor that this EventHandler will
62 * monitor. This may be -1, in which case the file
63 * descriptor must be set separately using initHandler() or
64 * changeHandlerFD() before the handler can be registered.
66 explicit EventHandler(EventBase* eventBase = nullptr, int fd = -1);
69 * EventHandler destructor.
71 * The event will be automatically unregistered if it is still registered.
73 virtual ~EventHandler();
76 * handlerReady() is invoked when the handler is ready.
78 * @param events A bitset indicating the events that are ready.
80 virtual void handlerReady(uint16_t events) noexcept = 0;
83 * Register the handler.
85 * If the handler is already registered, the registration will be updated
86 * to wait on the new set of events.
88 * @param events A bitset specifying the events to monitor.
89 * If the PERSIST bit is set, the handler will remain
90 * registered even after handlerReady() is called.
92 * @return Returns true if the handler was successfully registered,
93 * or false if an error occurred. After an error, the handler is
94 * always unregistered, even if it was already registered prior to
95 * this call to registerHandler().
97 bool registerHandler(uint16_t events) {
98 return registerImpl(events, false);
102 * Unregister the handler, if it is registered.
104 void unregisterHandler();
107 * Returns true if the handler is currently registered.
109 bool isHandlerRegistered() const {
110 return EventUtil::isEventRegistered(&event_);
114 * Attach the handler to a EventBase.
116 * This may only be called if the handler is not currently attached to a
117 * EventBase (either by using the default constructor, or by calling
118 * detachEventBase()).
120 * This method must be invoked in the EventBase's thread.
122 void attachEventBase(EventBase* eventBase);
125 * Detach the handler from its EventBase.
127 * This may only be called when the handler is not currently registered.
128 * Once detached, the handler may not be registered again until it is
129 * re-attached to a EventBase by calling attachEventBase().
131 * This method must be called from the current EventBase's thread.
133 void detachEventBase();
136 * Change the file descriptor that this handler is associated with.
138 * This may only be called when the handler is not currently registered.
140 void changeHandlerFD(int fd);
143 * Attach the handler to a EventBase, and change the file descriptor.
145 * This method may only be called if the handler is not currently attached to
146 * a EventBase. This is primarily intended to be used to initialize
147 * EventHandler objects created using the default constructor.
149 void initHandler(EventBase* eventBase, int fd);
152 * Return the set of events that we're currently registered for.
154 uint16_t getRegisteredEvents() const {
155 return (isHandlerRegistered()) ? uint16_t(event_.ev_events) : 0u;
159 * Register the handler as an internal event.
161 * This event will not count as an active event for determining if the
162 * EventBase loop has more events to process. The EventBase loop runs
163 * only as long as there are active EventHandlers, however "internal" event
164 * handlers are not counted. Therefore this event handler will not prevent
165 * EventBase loop from exiting with no more work to do if there are no other
166 * non-internal event handlers registered.
168 * This is intended to be used only in very rare cases by the internal
169 * EventBase code. This API is not guaranteed to remain stable or portable
172 bool registerInternalHandler(uint16_t events) {
173 return registerImpl(events, true);
176 bool isPending() const;
179 bool registerImpl(uint16_t events, bool internal);
180 void ensureNotRegistered(const char* fn);
182 void setEventBase(EventBase* eventBase);
184 static void libeventCallback(libevent_fd_t fd, short events, void* arg);
187 EventBase* eventBase_;