lib/grpc_kit/calls.rb in grpc_kit-0.1.8 vs lib/grpc_kit/calls.rb in grpc_kit-0.1.9

@@ -4,15 +4,26 @@
   module Calls
     class Call
       Name = Struct.new(:name, :receiver)
       Reciver = Struct.new(:class)
       Klass = Struct.new(:service_name)
+
+      # @return [GrpcKit::Calls::Call::Name] gRPC method object
       attr_reader :method
 
-      # @params stream [GrpcKit::Stream::ServerStream|GrpcKit::Stream::ClientStream]
-      # @params config [GrpcKit::MethodConfig]
-      # @params metadata [Hash]
+      # @return [Symbol] gRPC method name
+      attr_reader :method_name
+
+      # @return [String] gRPC service name
+      attr_reader :service_name
+
+      # @return [Hash<String, String>] gRPC metadata
+      attr_reader :metadata
+
+      # @param stream [GrpcKit::Stream::ServerStream|GrpcKit::Stream::ClientStream]
+      # @param config [GrpcKit::MethodConfig]
+      # @param metadata [Hash<String,String>]
       def initialize(stream:, config:, metadata:, timeout: nil)
         @config = config
         @metadata = metadata
         @method_name = @config.method_name
         @service_name = @config.service_name
@@ -24,17 +35,20 @@
         klass = Klass.new(@service_name)
         @method ||= Name.new(@method_name, Reciver.new(klass))
         @restrict = false
       end
 
+      # @return [void]
       def restrict_mode
         @restrict = true
       end
 
+      # @return [void]
       def normal_mode
         @restrict = false
       end
 
+      # @return [Time] deadline of this rpc call
       def deadline
         @deadline ||= @timeout.to_absolute_time
       end
     end
   end