| /* |
| * |
| * Copyright 2015, Google Inc. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are |
| * met: |
| * |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above |
| * copyright notice, this list of conditions and the following disclaimer |
| * in the documentation and/or other materials provided with the |
| * distribution. |
| * * Neither the name of Google Inc. nor the names of its |
| * contributors may be used to endorse or promote products derived from |
| * this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| * |
| */ |
| |
| #ifndef GRPC_CORE_LIB_IOMGR_WORKQUEUE_H |
| #define GRPC_CORE_LIB_IOMGR_WORKQUEUE_H |
| |
| #include "src/core/lib/iomgr/closure.h" |
| #include "src/core/lib/iomgr/exec_ctx.h" |
| #include "src/core/lib/iomgr/iomgr.h" |
| #include "src/core/lib/iomgr/pollset.h" |
| #include "src/core/lib/iomgr/pollset_set.h" |
| #include "src/core/lib/iomgr/port.h" |
| |
| #ifdef GPR_WINDOWS |
| #include "src/core/lib/iomgr/workqueue_windows.h" |
| #endif |
| |
| /* grpc_workqueue is forward declared in exec_ctx.h */ |
| |
| /* Reference counting functions. Use the macro's always |
| (GRPC_WORKQUEUE_{REF,UNREF}). |
| |
| Pass in a descriptive reason string for reffing/unreffing as the last |
| argument to each macro. When GRPC_WORKQUEUE_REFCOUNT_DEBUG is defined, that |
| string will be printed alongside the refcount. When it is not defined, the |
| string will be discarded at compilation time. */ |
| |
| /*#define GRPC_WORKQUEUE_REFCOUNT_DEBUG*/ |
| #ifdef GRPC_WORKQUEUE_REFCOUNT_DEBUG |
| #define GRPC_WORKQUEUE_REF(p, r) \ |
| grpc_workqueue_ref((p), __FILE__, __LINE__, (r)) |
| #define GRPC_WORKQUEUE_UNREF(exec_ctx, p, r) \ |
| grpc_workqueue_unref((exec_ctx), (p), __FILE__, __LINE__, (r)) |
| grpc_workqueue *grpc_workqueue_ref(grpc_workqueue *workqueue, const char *file, |
| int line, const char *reason); |
| void grpc_workqueue_unref(grpc_exec_ctx *exec_ctx, grpc_workqueue *workqueue, |
| const char *file, int line, const char *reason); |
| #else |
| #define GRPC_WORKQUEUE_REF(p, r) grpc_workqueue_ref((p)) |
| #define GRPC_WORKQUEUE_UNREF(cl, p, r) grpc_workqueue_unref((cl), (p)) |
| grpc_workqueue *grpc_workqueue_ref(grpc_workqueue *workqueue); |
| void grpc_workqueue_unref(grpc_exec_ctx *exec_ctx, grpc_workqueue *workqueue); |
| #endif |
| |
| /** Add a work item to a workqueue. Items added to a work queue will be started |
| in approximately the order they were enqueued, on some thread that may or |
| may not be the current thread. Successive closures enqueued onto a workqueue |
| MAY be executed concurrently. |
| |
| It is generally more expensive to add a closure to a workqueue than to the |
| execution context, both in terms of CPU work and in execution latency. |
| |
| Use work queues when it's important that other threads be given a chance to |
| tackle some workload. */ |
| void grpc_workqueue_enqueue(grpc_exec_ctx *exec_ctx, grpc_workqueue *workqueue, |
| grpc_closure *closure, grpc_error *error); |
| |
| #endif /* GRPC_CORE_LIB_IOMGR_WORKQUEUE_H */ |