David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 6169d5f | 2016-03-31 07:46:18 -0700 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 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 | /// An Alarm posts the user provided tag to its associated completion queue upon |
| 35 | /// expiry or cancellation. |
| 36 | #ifndef GRPCXX_ALARM_H |
| 37 | #define GRPCXX_ALARM_H |
| 38 | |
David Garcia Quintas | 45add8a | 2016-02-22 23:15:28 -0800 | [diff] [blame] | 39 | #include <grpc++/impl/codegen/completion_queue.h> |
Vijay Pai | 810a13e | 2016-02-11 03:30:10 -0800 | [diff] [blame] | 40 | #include <grpc++/impl/codegen/completion_queue_tag.h> |
David Garcia Quintas | e1300de | 2016-01-27 18:41:26 -0800 | [diff] [blame] | 41 | #include <grpc++/impl/codegen/grpc_library.h> |
| 42 | #include <grpc++/impl/codegen/time.h> |
David Garcia Quintas | 45add8a | 2016-02-22 23:15:28 -0800 | [diff] [blame] | 43 | #include <grpc++/impl/grpc_library.h> |
David Garcia Quintas | 5e07d76 | 2016-02-17 17:10:41 -0800 | [diff] [blame] | 44 | #include <grpc/grpc.h> |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 45 | |
vjpai | 04e992a | 2016-02-10 16:58:38 -0800 | [diff] [blame] | 46 | struct grpc_alarm; |
| 47 | |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 48 | namespace grpc { |
| 49 | |
David Garcia Quintas | e1300de | 2016-01-27 18:41:26 -0800 | [diff] [blame] | 50 | class CompletionQueue; |
| 51 | |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 52 | /// A thin wrapper around \a grpc_alarm (see / \a / src/core/surface/alarm.h). |
David Garcia Quintas | 60ee8dd | 2016-03-08 17:21:42 -0800 | [diff] [blame] | 53 | class Alarm : private GrpcLibraryCodegen { |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 54 | public: |
| 55 | /// Create a completion queue alarm instance associated to \a cq. |
| 56 | /// |
| 57 | /// Once the alarm expires (at \a deadline) or it's cancelled (see \a Cancel), |
| 58 | /// an event with tag \a tag will be added to \a cq. If the alarm expired, the |
| 59 | /// event's success bit will be true, false otherwise (ie, upon cancellation). |
David Garcia Quintas | 0160873 | 2016-02-22 17:49:45 -0800 | [diff] [blame] | 60 | /// \internal We rely on the presence of \a cq for grpc initialization. If \a |
| 61 | /// cq were ever to be removed, a reference to a static |
| 62 | /// internal::GrpcLibraryInitializer instance would need to be introduced |
| 63 | /// here. \endinternal. |
David Garcia Quintas | 5e07d76 | 2016-02-17 17:10:41 -0800 | [diff] [blame] | 64 | template <typename T> |
| 65 | Alarm(CompletionQueue* cq, const T& deadline, void* tag) |
| 66 | : tag_(tag), |
| 67 | alarm_(grpc_alarm_create(cq->cq(), TimePoint<T>(deadline).raw_time(), |
| 68 | static_cast<void*>(&tag_))) {} |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 69 | |
| 70 | /// Destroy the given completion queue alarm, cancelling it in the process. |
David Garcia Quintas | 45add8a | 2016-02-22 23:15:28 -0800 | [diff] [blame] | 71 | ~Alarm() { grpc_alarm_destroy(alarm_); } |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 72 | |
| 73 | /// Cancel a completion queue alarm. Calling this function over an alarm that |
| 74 | /// has already fired has no effect. |
David Garcia Quintas | 45add8a | 2016-02-22 23:15:28 -0800 | [diff] [blame] | 75 | void Cancel() { grpc_alarm_cancel(alarm_); } |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 76 | |
| 77 | private: |
Vijay Pai | 810a13e | 2016-02-11 03:30:10 -0800 | [diff] [blame] | 78 | class AlarmEntry : public CompletionQueueTag { |
| 79 | public: |
| 80 | AlarmEntry(void* tag) : tag_(tag) {} |
Vijay Pai | c0b2acb | 2016-11-01 16:31:56 -0700 | [diff] [blame] | 81 | bool FinalizeResult(void** tag, bool* status) override { |
Vijay Pai | 810a13e | 2016-02-11 03:30:10 -0800 | [diff] [blame] | 82 | *tag = tag_; |
| 83 | return true; |
| 84 | } |
| 85 | |
| 86 | private: |
| 87 | void* tag_; |
| 88 | }; |
| 89 | |
| 90 | AlarmEntry tag_; |
David Garcia Quintas | 7fd0fd5 | 2015-10-07 17:41:08 -0700 | [diff] [blame] | 91 | grpc_alarm* const alarm_; // owned |
| 92 | }; |
| 93 | |
| 94 | } // namespace grpc |
| 95 | |
| 96 | #endif // GRPCXX_ALARM_H |