RegistrableRPCService.swift 1.5 KB

12345678910111213141516171819202122232425262728293031
  1. /*
  2. * Copyright 2023, gRPC Authors All rights reserved.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. /// An RPC service which can register its methods with an ``RPCRouter``.
  17. ///
  18. /// You typically won't have to implement this protocol yourself as the generated service code
  19. /// provides conformance for your generated service type. However, if you need to customise which
  20. /// methods your service offers or how the methods are registered then you can override the
  21. /// generated conformance by implementing ``registerMethods(with:)`` manually by calling
  22. /// ``RPCRouter/registerHandler(forMethod:deserializer:serializer:handler:)`` for each method
  23. /// you want to register with the router.
  24. @available(macOS 13.0, iOS 16.0, watchOS 9.0, tvOS 16.0, *)
  25. public protocol RegistrableRPCService: Sendable {
  26. /// Registers methods to server with the provided ``RPCRouter``.
  27. ///
  28. /// - Parameter router: The router to register methods with.
  29. func registerMethods(with router: inout RPCRouter)
  30. }