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
connectivity_state.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_TRANSPORT_CONNECTIVITY_STATE_H
35 #define GRPC_INTERNAL_CORE_TRANSPORT_CONNECTIVITY_STATE_H
36
37 #include <grpc/grpc.h>
38 #include "src/core/iomgr/iomgr.h"
39
40 typedef struct grpc_connectivity_state_watcher {
42 struct grpc_connectivity_state_watcher *next;
44 grpc_iomgr_closure *notify;
46 grpc_connectivity_state *current;
47 } grpc_connectivity_state_watcher;
48
49 typedef struct {
51 grpc_connectivity_state current_state;
53 grpc_connectivity_state_watcher *watchers;
55 char *name;
56 } grpc_connectivity_state_tracker;
57
58 extern int grpc_connectivity_state_trace;
59
60 void grpc_connectivity_state_init(grpc_connectivity_state_tracker *tracker,
61 grpc_connectivity_state init_state,
62 const char *name);
63 void grpc_connectivity_state_destroy(grpc_connectivity_state_tracker *tracker);
64
65 void grpc_connectivity_state_set(grpc_connectivity_state_tracker *tracker,
66 grpc_connectivity_state state,
67 const char *reason);
68 void grpc_connectivity_state_set_with_scheduler(
69 grpc_connectivity_state_tracker *tracker, grpc_connectivity_state state,
70 void (*scheduler)(void *arg, grpc_iomgr_closure *closure), void *arg,
71 const char *reason);
72
73 grpc_connectivity_state grpc_connectivity_state_check(
74 grpc_connectivity_state_tracker *tracker);
75
77 int grpc_connectivity_state_notify_on_state_change(
78 grpc_connectivity_state_tracker *tracker, grpc_connectivity_state *current,
79 grpc_iomgr_closure *notify);
80
81 #endif /* GRPC_INTERNAL_CORE_TRANSPORT_CONNECTIVITY_STATE_H */
grpc_connectivity_state
grpc_connectivity_state
Connectivity state of a channel.
Definition: grpc.h:139
grpc_connectivity_state_tracker::name
char * name
a name to help debugging
Definition: connectivity_state.h:55
grpc_connectivity_state_notify_on_state_change
int grpc_connectivity_state_notify_on_state_change(grpc_connectivity_state_tracker *tracker, grpc_connectivity_state *current, grpc_iomgr_closure *notify)
Return 1 if the channel should start connecting, 0 otherwise.
Definition: connectivity_state.c:87
grpc_connectivity_state_watcher::next
struct grpc_connectivity_state_watcher * next
we keep watchers in a linked list
Definition: connectivity_state.h:42
grpc_connectivity_state_set_with_scheduler
void grpc_connectivity_state_set_with_scheduler(grpc_connectivity_state_tracker *tracker, grpc_connectivity_state state, void(*scheduler)(void *arg, grpc_iomgr_closure *closure), void *arg, const char *reason)
Definition: connectivity_state.c:108
arg
Definition: cmdline.c:47
grpc_connectivity_state_watcher
struct grpc_connectivity_state_watcher grpc_connectivity_state_watcher
grpc_connectivity_state_tracker::watchers
grpc_connectivity_state_watcher * watchers
all our watchers
Definition: connectivity_state.h:53
grpc_connectivity_state_set
void grpc_connectivity_state_set(grpc_connectivity_state_tracker *tracker, grpc_connectivity_state state, const char *reason)
Definition: connectivity_state.c:143
grpc_iomgr_closure
A closure over a grpc_iomgr_cb_func.
Definition: iomgr.h:45
grpc_connectivity_state_watcher::notify
grpc_iomgr_closure * notify
closure to notify on change
Definition: connectivity_state.h:44
grpc_connectivity_state_check
grpc_connectivity_state grpc_connectivity_state_check(grpc_connectivity_state_tracker *tracker)
Definition: connectivity_state.c:82
grpc_connectivity_state_watcher::current
grpc_connectivity_state * current
the current state as believed by the watcher
Definition: connectivity_state.h:46
grpc_connectivity_state_destroy
void grpc_connectivity_state_destroy(grpc_connectivity_state_tracker *tracker)
Definition: connectivity_state.c:66
grpc_connectivity_state_tracker::current_state
grpc_connectivity_state current_state
current connectivity state
Definition: connectivity_state.h:51
grpc_connectivity_state_init
void grpc_connectivity_state_init(grpc_connectivity_state_tracker *tracker, grpc_connectivity_state init_state, const char *name)
Definition: connectivity_state.c:58
iomgr.h
grpc_connectivity_state_trace
int grpc_connectivity_state_trace
Definition: connectivity_state.c:39
grpc.h
grpc_connectivity_state_watcher
Definition: connectivity_state.h:40
grpc_connectivity_state_tracker
Definition: connectivity_state.h:49