| David Klempner | 7f3ed1e | 2015-01-16 15:35:56 -0800 | [diff] [blame^] | 1 | /* |
| 2 | * |
| 3 | * Copyright 2015, Google Inc. |
| 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
| 34 | #ifndef __GRPC_INTERNAL_IOMGR_POLLSET_KICK_H_ |
| 35 | #define __GRPC_INTERNAL_IOMGR_POLLSET_KICK_H_ |
| 36 | |
| 37 | #include <grpc/support/port_platform.h> |
| 38 | |
| 39 | /* This is an abstraction around the typical pipe mechanism for waking up a |
| 40 | thread sitting in a poll() style call. */ |
| 41 | |
| 42 | #ifdef GPR_POSIX_SOCKET |
| 43 | #include "src/core/iomgr/pollset_kick_posix.h" |
| 44 | #else |
| 45 | #error "No pollset kick support on platform" |
| 46 | #endif |
| 47 | |
| 48 | void grpc_pollset_kick_global_init(void); |
| 49 | void grpc_pollset_kick_global_destroy(void); |
| 50 | |
| 51 | void grpc_pollset_kick_init(grpc_pollset_kick_state *kick_state); |
| 52 | void grpc_pollset_kick_destroy(grpc_pollset_kick_state *kick_state); |
| 53 | |
| 54 | /* Must be called before entering poll(). If return value is -1, this consumed |
| 55 | an existing kick. Otherwise the return value is an FD to add to the poll set. |
| 56 | */ |
| 57 | int grpc_pollset_kick_pre_poll(grpc_pollset_kick_state *kick_state); |
| 58 | |
| 59 | /* Consume an existing kick. Must be called after poll returns that the fd was |
| 60 | readable, and before calling kick_post_poll. */ |
| 61 | void grpc_pollset_kick_consume(grpc_pollset_kick_state *kick_state); |
| 62 | |
| 63 | /* Must be called after pre_poll, and after consume if applicable */ |
| 64 | void grpc_pollset_kick_post_poll(grpc_pollset_kick_state *kick_state); |
| 65 | |
| 66 | void grpc_pollset_kick_kick(grpc_pollset_kick_state *kick_state); |
| 67 | |
| 68 | #endif /* __GRPC_INTERNAL_IOMGR_POLLSET_KICK_H_ */ |