2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /* High-level wrapper around the "poll" system call.
19 * Intended usage is for the program's main loop to go about its business
20 * servicing whatever events it needs to. Then, when it runs out of immediate
21 * tasks, it calls each subordinate module's "wait" function, which in turn
22 * calls one (or more) of the functions poll_fd_wait(), poll_immediate_wake(),
23 * and poll_timer_wait() to register to be awakened when the appropriate event
24 * occurs. Then the main loop calls poll_block(), which blocks until one of
25 * the registered events happens. */
38 /* Schedule events to wake up the following poll_block(). */
39 struct poll_waiter *poll_fd_wait(int fd, short int events);
40 void poll_timer_wait(long long int msec);
41 void poll_timer_wait_until(long long int msec);
42 void poll_immediate_wake(void);
44 /* Wait until an event occurs. */
45 void poll_block(void);
47 /* Cancel a file descriptor callback or event. */
48 void poll_cancel(struct poll_waiter *);
54 #endif /* poll-loop.h */