GRPC Core  4.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups 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 
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 typedef uintptr_t gpr_thd_id;
52 
54 typedef struct {
55  int flags;
57 
62 GPRAPI int gpr_thd_new(gpr_thd_id *t, void (*thd_body)(void *arg), void *arg,
63  const gpr_thd_options *options);
64 
67 
70 
73 
76 
79 
81 GPRAPI gpr_thd_id gpr_thd_currentid(void);
82 
85 GPRAPI void gpr_thd_join(gpr_thd_id t);
86 
87 #ifdef __cplusplus
88 }
89 #endif
90 
91 #endif /* GRPC_SUPPORT_THD_H */
GPRAPI gpr_thd_options gpr_thd_options_default(void)
Return a gpr_thd_options struct with all fields set to defaults.
#define GPRAPI
Definition: port_platform.h:416
GPRAPI int gpr_thd_new(gpr_thd_id *t, void(*thd_body)(void *arg), void *arg, const gpr_thd_options *options)
Create a new thread running (*thd_body)(arg) and place its thread identifier in *t, and return true.
int flags
Definition: thd.h:55
GPRAPI void gpr_thd_options_set_detached(gpr_thd_options *options)
Set the thread to become detached on startup - this is the default.
GPRAPI gpr_thd_id gpr_thd_currentid(void)
Returns the identifier of the current thread.
uintptr_t gpr_thd_id
Thread interface for GPR.
Definition: thd.h:51
GPRAPI void gpr_thd_options_set_joinable(gpr_thd_options *options)
Set the thread to become joinable - mutually exclusive with detached.
GPRAPI void gpr_thd_join(gpr_thd_id t)
Blocks until the specified thread properly terminates.
GPRAPI int gpr_thd_options_is_detached(const gpr_thd_options *options)
Returns non-zero if the option detached is set.
Thread creation options.
Definition: thd.h:54
GPRAPI int gpr_thd_options_is_joinable(const gpr_thd_options *options)
Returns non-zero if the option joinable is set.