Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Copyright 2016, 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 | |
Craig Tiller | 2f1d870 | 2016-10-18 16:09:26 -0700 | [diff] [blame] | 34 | #ifndef GRPCXX_RESOURCE_QUOTA_H |
| 35 | #define GRPCXX_RESOURCE_QUOTA_H |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 36 | |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 37 | struct grpc_resource_quota; |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 38 | |
| 39 | #include <grpc++/impl/codegen/config.h> |
Craig Tiller | 801c6cc | 2017-01-03 08:13:13 -0800 | [diff] [blame] | 40 | #include <grpc++/impl/codegen/grpc_library.h> |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 41 | |
| 42 | namespace grpc { |
| 43 | |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 44 | /// ResourceQuota represents a bound on memory usage by the gRPC library. |
| 45 | /// A ResourceQuota can be attached to a server (via ServerBuilder), or a client |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 46 | /// channel (via ChannelArguments). gRPC will attempt to keep memory used by |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 47 | /// all attached entities below the ResourceQuota bound. |
Craig Tiller | 801c6cc | 2017-01-03 08:13:13 -0800 | [diff] [blame] | 48 | class ResourceQuota final : private GrpcLibraryCodegen { |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 49 | public: |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 50 | explicit ResourceQuota(const grpc::string& name); |
| 51 | ResourceQuota(); |
| 52 | ~ResourceQuota(); |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 53 | |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 54 | /// Resize this ResourceQuota to a new size. If new_size is smaller than the |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 55 | /// current size of the pool, memory usage will be monotonically decreased |
| 56 | /// until it falls under new_size. No time bound is given for this to occur |
| 57 | /// however. |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 58 | ResourceQuota& Resize(size_t new_size); |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 59 | |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 60 | grpc_resource_quota* c_resource_quota() const { return impl_; } |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 61 | |
| 62 | private: |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 63 | ResourceQuota(const ResourceQuota& rhs); |
| 64 | ResourceQuota& operator=(const ResourceQuota& rhs); |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 65 | |
Craig Tiller | 20afa3d | 2016-10-17 14:52:14 -0700 | [diff] [blame] | 66 | grpc_resource_quota* const impl_; |
Craig Tiller | db1a5cc | 2016-09-28 14:22:12 -0700 | [diff] [blame] | 67 | }; |
| 68 | |
| 69 | } // namespace grpc |
| 70 | |
Craig Tiller | 2f1d870 | 2016-10-18 16:09:26 -0700 | [diff] [blame] | 71 | #endif // GRPCXX_RESOURCE_QUOTA_H |