GRPC Core 0.10.0.0

- Main Page
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
alarm_internal.h
Go to the documentation of this file.
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_CORE_IOMGR_ALARM_INTERNAL_H
35 #define GRPC_INTERNAL_CORE_IOMGR_ALARM_INTERNAL_H
36
37 #include <grpc/support/sync.h>
38 #include <grpc/support/time.h>
39
40 /* iomgr internal api for dealing with alarms */
41
42 /* Check for alarms to be run, and run them.
43 Return non zero if alarm callbacks were executed.
44 Drops drop_mu if it is non-null before executing callbacks.
45 If next is non-null, TRY to update *next with the next running alarm
46 IF that alarm occurs before *next current value.
47 *next is never guaranteed to be updated on any given execution; however,
48 with high probability at least one thread in the system will see an update
49 at any time slice. */
50
51 int grpc_alarm_check(gpr_mu *drop_mu, gpr_timespec now, gpr_timespec *next);
52
53 void grpc_alarm_list_init(gpr_timespec now);
54 void grpc_alarm_list_shutdown(void);
55
56 gpr_timespec grpc_alarm_list_next_timeout(void);
57
58 /* the following must be implemented by each iomgr implementation */
59
60 void grpc_kick_poller(void);
61
62 #endif /* GRPC_INTERNAL_CORE_IOMGR_ALARM_INTERNAL_H */
grpc_alarm_list_init
void grpc_alarm_list_init(gpr_timespec now)
Definition: alarm.c:85
time.h
grpc_alarm_check
int grpc_alarm_check(gpr_mu *drop_mu, gpr_timespec now, gpr_timespec *next)
Definition: alarm.c:362
gpr_mu
Definition: sync_win32.h:39
grpc_kick_poller
void grpc_kick_poller(void)
Definition: iomgr.c:82
sync.h
grpc_alarm_list_next_timeout
gpr_timespec grpc_alarm_list_next_timeout(void)
Definition: alarm.c:369
gpr_timespec
Definition: time.h:60
grpc_alarm_list_shutdown
void grpc_alarm_list_shutdown(void)
Definition: alarm.c:106