| /* |
| * |
| * Copyright 2015 gRPC authors. |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| * |
| */ |
| |
| #ifndef GRPC_SUPPORT_THD_H |
| #define GRPC_SUPPORT_THD_H |
| /** Thread interface for GPR. |
| |
| Types |
| gpr_thd_id a thread identifier. |
| (Currently no calls take a thread identifier. |
| It exists for future extensibility.) |
| gpr_thd_options options used when creating a thread |
| */ |
| |
| #include <grpc/support/port_platform.h> |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| typedef uintptr_t gpr_thd_id; |
| |
| /** Thread creation options. */ |
| typedef struct { |
| int flags; /** Opaque field. Get and set with accessors below. */ |
| } gpr_thd_options; |
| |
| /** Create a new thread running (*thd_body)(arg) and place its thread identifier |
| in *t, and return true. If there are insufficient resources, return false. |
| thd_name is the name of the thread for identification purposes on platforms |
| that support thread naming. |
| If options==NULL, default options are used. |
| The thread is immediately runnable, and exits when (*thd_body)() returns. */ |
| GPRAPI int gpr_thd_new(gpr_thd_id* t, const char* thd_name, |
| void (*thd_body)(void* arg), void* arg, |
| const gpr_thd_options* options); |
| |
| /** Return a gpr_thd_options struct with all fields set to defaults. */ |
| GPRAPI gpr_thd_options gpr_thd_options_default(void); |
| |
| /** Set the thread to become detached on startup - this is the default. */ |
| GPRAPI void gpr_thd_options_set_detached(gpr_thd_options* options); |
| |
| /** Set the thread to become joinable - mutually exclusive with detached. */ |
| GPRAPI void gpr_thd_options_set_joinable(gpr_thd_options* options); |
| |
| /** Returns non-zero if the option detached is set. */ |
| GPRAPI int gpr_thd_options_is_detached(const gpr_thd_options* options); |
| |
| /** Returns non-zero if the option joinable is set. */ |
| GPRAPI int gpr_thd_options_is_joinable(const gpr_thd_options* options); |
| |
| /** Returns the identifier of the current thread. */ |
| GPRAPI gpr_thd_id gpr_thd_currentid(void); |
| |
| /** Blocks until the specified thread properly terminates. |
| Calling this on a detached thread has unpredictable results. */ |
| GPRAPI void gpr_thd_join(gpr_thd_id t); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* GRPC_SUPPORT_THD_H */ |