Browse Source

Make GRPCClientChannelHandler underscore internal (#662)

* Make GRPCClientChannelHandler underscore internal
George Barnett 6 years ago
parent
commit
08a5dd7ea9

+ 1 - 1
Sources/GRPC/ClientCalls/BaseClientCall.swift

@@ -98,7 +98,7 @@ public class BaseClientCall<Request: Message, Response: Message>: ClientCall {
     self.multiplexer.whenSuccess { multiplexer in
       multiplexer.createStreamChannel(promise: streamPromise) { (stream, streamID) -> EventLoopFuture<Void> in
         stream.pipeline.addHandlers([
-          GRPCClientChannelHandler<Request, Response>(streamID: streamID, callType: callType, logger: logger),
+          _GRPCClientChannelHandler<Request, Response>(streamID: streamID, callType: callType, logger: logger),
           responseHandler,
           requestHandler
         ])

+ 6 - 3
Sources/GRPC/GRPCClientChannelHandler.swift → Sources/GRPC/_GRPCClientChannelHandler.swift

@@ -203,7 +203,10 @@ public enum GRPCCallType {
 ///   return channel.pipeline.addHandler(clientChannelHandler)
 /// }
 /// ```
-public final class GRPCClientChannelHandler<Request: Message, Response: Message> {
+///
+/// - Important: This is **NOT** part of the public API. It is declared as
+///   `public` because it is used within performance tests.
+public final class _GRPCClientChannelHandler<Request: Message, Response: Message> {
   private let logger: Logger
   private let streamID: HTTP2StreamID
   private var stateMachine: GRPCClientStateMachine<Request, Response>
@@ -232,7 +235,7 @@ public final class GRPCClientChannelHandler<Request: Message, Response: Message>
 }
 
 // MARK: - GRPCClientChannelHandler: Inbound
-extension GRPCClientChannelHandler: ChannelInboundHandler {
+extension _GRPCClientChannelHandler: ChannelInboundHandler {
   public typealias InboundIn = HTTP2Frame
   public typealias InboundOut = GRPCClientResponsePart<Response>
 
@@ -366,7 +369,7 @@ extension GRPCClientChannelHandler: ChannelInboundHandler {
 }
 
 // MARK: - GRPCClientChannelHandler: Outbound
-extension GRPCClientChannelHandler: ChannelOutboundHandler {
+extension _GRPCClientChannelHandler: ChannelOutboundHandler {
   public typealias OutboundIn = GRPCClientRequestPart<Request>
   public typealias OutboundOut = HTTP2Frame
 

+ 1 - 1
Sources/GRPCPerformanceTests/Benchmarks/EmbeddedClientThroughput.swift

@@ -61,7 +61,7 @@ class EmbeddedClientThroughput: Benchmark {
     for _ in 0..<self.requestCount {
       let channel = EmbeddedChannel()
       try channel.pipeline.addHandlers([
-        GRPCClientChannelHandler<Echo_EchoRequest, Echo_EchoResponse>(streamID: .init(1), callType: .unary, logger: self.logger),
+        _GRPCClientChannelHandler<Echo_EchoRequest, Echo_EchoResponse>(streamID: .init(1), callType: .unary, logger: self.logger),
         _UnaryRequestChannelHandler(requestHead: self.requestHead, request: .init(self.request))
       ]).wait()
 

+ 1 - 1
Tests/GRPCTests/GRPCStatusCodeTests.swift

@@ -37,7 +37,7 @@ class GRPCStatusCodeTests: GRPCTestCase {
     self.status = statusPromise.futureResult
 
     try! self.channel.pipeline.addHandlers([
-      GRPCClientChannelHandler<Echo_EchoRequest, Echo_EchoResponse>(streamID: .init(1), callType: .unary, logger: logger),
+      _GRPCClientChannelHandler<Echo_EchoRequest, Echo_EchoResponse>(streamID: .init(1), callType: .unary, logger: logger),
       GRPCClientUnaryResponseChannelHandler<Echo_EchoResponse>(
         initialMetadataPromise: channel.eventLoop.makePromise(),
         trailingMetadataPromise: channel.eventLoop.makePromise(),