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
thd.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_SUPPORT_THD_H
35 #define GRPC_SUPPORT_THD_H
36 /* Thread interface for GPR.
37
38 Types
39 gpr_thd_id a thread identifier.
40 (Currently no calls take a thread identifier.
41 It exists for future extensibility.)
42 gpr_thd_options options used when creating a thread
43 */
44
45 #include <grpc/support/port_platform.h>
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 typedef gpr_uint64 gpr_thd_id;
52
53 /* Thread creation options. */
54 typedef struct {
55 int flags; /* Opaque field. Get and set with accessors below. */
56 } gpr_thd_options;
57
58 /* Create a new thread running (*thd_body)(arg) and place its thread identifier
59 in *t, and return true. If there are insufficient resources, return false.
60 If options==NULL, default options are used.
61 The thread is immediately runnable, and exits when (*thd_body)() returns. */
62 int gpr_thd_new(gpr_thd_id *t, void (*thd_body)(void *arg), void *arg,
63 const gpr_thd_options *options);
64
65 /* Return a gpr_thd_options struct with all fields set to defaults. */
66 gpr_thd_options gpr_thd_options_default(void);
67
68 /* Set the thread to become detached on startup - this is the default. */
69 void gpr_thd_options_set_detached(gpr_thd_options *options);
70
71 /* Set the thread to become joinable - mutually exclusive with detached. */
72 void gpr_thd_options_set_joinable(gpr_thd_options *options);
73
74 /* Returns non-zero if the option detached is set. */
75 int gpr_thd_options_is_detached(const gpr_thd_options *options);
76
77 /* Returns non-zero if the option joinable is set. */
78 int gpr_thd_options_is_joinable(const gpr_thd_options *options);
79
80 /* Returns the identifier of the current thread. */
81 gpr_thd_id gpr_thd_currentid(void);
82
83 /* Blocks until the specified thread properly terminates.
84 Calling this on a detached thread has unpredictable results. */
85 void gpr_thd_join(gpr_thd_id t);
86
87 #ifdef __cplusplus
88 }
89 #endif
90
91 #endif /* GRPC_SUPPORT_THD_H */
gpr_thd_options_set_joinable
void gpr_thd_options_set_joinable(gpr_thd_options *options)
port_platform.h
gpr_thd_new
int gpr_thd_new(gpr_thd_id *t, void(*thd_body)(void *arg), void *arg, const gpr_thd_options *options)
gpr_thd_options::flags
int flags
Definition: thd.h:55
gpr_thd_join
void gpr_thd_join(gpr_thd_id t)
gpr_thd_options_is_joinable
int gpr_thd_options_is_joinable(const gpr_thd_options *options)
gpr_thd_currentid
gpr_thd_id gpr_thd_currentid(void)
gpr_uint64
uint64_t gpr_uint64
Definition: port_platform.h:310
gpr_thd_options_default
gpr_thd_options gpr_thd_options_default(void)
gpr_thd_options_is_detached
int gpr_thd_options_is_detached(const gpr_thd_options *options)
gpr_thd_options
Definition: thd.h:54
gpr_thd_options_set_detached
void gpr_thd_options_set_detached(gpr_thd_options *options)
gpr_thd_id
gpr_uint64 gpr_thd_id
Definition: thd.h:51