1 // Copyright 2021 The Pigweed Authors 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not 4 // use this file except in compliance with the License. You may obtain a copy of 5 // the License at 6 // 7 // https://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 // License for the specific language governing permissions and limitations under 13 // the License. 14 #pragma once 15 16 #include <cstdint> 17 #include <type_traits> 18 19 namespace pw::rpc::internal { 20 21 template <auto> 22 constexpr std::false_type kIsGeneratedRpcFunction{}; 23 24 // The MethodInfo class provides metadata about an RPC. This class is 25 // specialized for the static RPC client functions in the generated code. This 26 // makes it possible for pw_rpc to access method metadata with a simple API. The 27 // user passes the method name (e.g. pw_rpc::raw::MyService::MyMethod) as a 28 // template parameter, and pw_rpc can extract information like method and 29 // service IDs at compile time. 30 template <auto kRpcFunction> 31 struct MethodInfo { 32 // MethodInfo specializations always provide the service and method IDs and a 33 // function that returns the implementation method for this RPC given a 34 // service implementation class. 35 static constexpr uint32_t kServiceId = 0; 36 static constexpr uint32_t kMethodId = 0; 37 38 template <typename ServiceImpl> FunctionMethodInfo39 static constexpr void Function() {} 40 41 static_assert(kIsGeneratedRpcFunction<kRpcFunction>, 42 "The provided argument is not a generated pw_rpc function. " 43 "Pass a pw_rpc function such as " 44 "my_pkg::pw_rpc::raw:::MyService::MyMethod instead."); 45 }; 46 47 } // namespace pw::rpc::internal 48