/Users/deen/code/yugabyte-db/src/yb/rpc/rpc_service.h
Line | Count | Source |
1 | | // Licensed to the Apache Software Foundation (ASF) under one |
2 | | // or more contributor license agreements. See the NOTICE file |
3 | | // distributed with this work for additional information |
4 | | // regarding copyright ownership. The ASF licenses this file |
5 | | // to you under the Apache License, Version 2.0 (the |
6 | | // "License"); you may not use this file except in compliance |
7 | | // with the License. You may obtain a copy of the License at |
8 | | // |
9 | | // http://www.apache.org/licenses/LICENSE-2.0 |
10 | | // |
11 | | // Unless required by applicable law or agreed to in writing, |
12 | | // software distributed under the License is distributed on an |
13 | | // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
14 | | // KIND, either express or implied. See the License for the |
15 | | // specific language governing permissions and limitations |
16 | | // under the License. |
17 | | // |
18 | | // The following only applies to changes made to this file as part of YugaByte development. |
19 | | // |
20 | | // Portions Copyright (c) YugaByte, Inc. |
21 | | // |
22 | | // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
23 | | // in compliance with the License. You may obtain a copy of the License at |
24 | | // |
25 | | // http://www.apache.org/licenses/LICENSE-2.0 |
26 | | // |
27 | | // Unless required by applicable law or agreed to in writing, software distributed under the License |
28 | | // is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
29 | | // or implied. See the License for the specific language governing permissions and limitations |
30 | | // under the License. |
31 | | // |
32 | | #ifndef YB_RPC_RPC_SERVICE_H |
33 | | #define YB_RPC_RPC_SERVICE_H |
34 | | |
35 | | #include "yb/rpc/rpc_fwd.h" |
36 | | |
37 | | namespace yb { |
38 | | namespace rpc { |
39 | | |
40 | | class RpcService : public RefCountedThreadSafe<RpcService> { |
41 | | public: |
42 | 2.02k | virtual ~RpcService() {} |
43 | | |
44 | | virtual void FillEndpoints(RpcEndpointMap* map) = 0; |
45 | | |
46 | | // Enqueue a call for processing. |
47 | | // On failure, the RpcService::QueueInboundCall() implementation is |
48 | | // responsible for responding to the client with a failure message. |
49 | | virtual void QueueInboundCall(InboundCallPtr call) = 0; |
50 | | |
51 | | // Handle a call directly. |
52 | | virtual void Handle(InboundCallPtr call) = 0; |
53 | | |
54 | | // Initiate RPC service shutdown. |
55 | | // Two phase shutdown is required to prevent shutdown deadlock of 2 dependent resources. |
56 | | virtual void StartShutdown() = 0; |
57 | | |
58 | | // Wait until RPC sevrice shutdown completes. |
59 | | virtual void CompleteShutdown() = 0; |
60 | | |
61 | 83 | void Shutdown() { |
62 | 83 | StartShutdown(); |
63 | 83 | CompleteShutdown(); |
64 | 83 | } |
65 | | }; |
66 | | |
67 | | } // namespace rpc |
68 | | } // namespace yb |
69 | | |
70 | | #endif // YB_RPC_RPC_SERVICE_H |