Sha256: d2dda9af028cc89cb124dcad53f788471ac6f2e5682a271ad808c56ae80e82a0

Contents?: true

Size: 1.87 KB

Versions: 41

Compression:

Stored size: 1.87 KB

Contents

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

module Gapic
  ##
  # Manages requests for an input stream and holds the stream open until {#close} is called.
  #
  class StreamInput
    ##
    # Create a new input stream object to manage streaming requests and hold the stream open until {#close} is called.
    #
    # @param requests [Object]
    #
    def initialize *requests
      @queue = Queue.new

      # Push initial requests into the queue
      requests.each { |request| @queue.push request }
    end

    ##
    # Adds a request object to the stream.
    #
    # @param request [Object]
    #
    # @return [StreamInput] Returns self.
    #
    def push request
      @queue.push request

      self
    end
    alias << push
    alias append push

    ##
    # Closes the stream.
    #
    # @return [StreamInput] Returns self.
    #
    def close
      @queue.push self

      self
    end

    ##
    # @private
    # Iterates the requests given to the stream.
    #
    # @yield [request] The block for accessing each request.
    # @yieldparam [Object] request The request object.
    #
    # @return [Enumerator] An Enumerator is returned if no block is given.
    #
    def to_enum
      return enum_for :to_enum unless block_given?
      loop do
        request = @queue.pop
        break if request.equal? self
        yield request
      end
    end
  end
end

Version data entries

41 entries across 41 versions & 3 rubygems

Version Path
gapic-common-0.25.0 lib/gapic/stream_input.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/gapic-common-0.24.0/lib/gapic/stream_input.rb
gapic-common-0.24.0 lib/gapic/stream_input.rb
gapic-common-0.23.0 lib/gapic/stream_input.rb
gapic-common-0.22.0 lib/gapic/stream_input.rb
gapic-common-0.21.1 lib/gapic/stream_input.rb
gapic-common-0.20.0 lib/gapic/stream_input.rb
gapic-common-0.19.1 lib/gapic/stream_input.rb
gapic-common-0.19.0 lib/gapic/stream_input.rb
fluent-plugin-google-cloud-logging-on-prem-0.1.0 vendor/ruby/3.1.0/gems/gapic-common-0.18.0/lib/gapic/stream_input.rb
gapic-common-0.18.0 lib/gapic/stream_input.rb
gapic-common-0.17.1 lib/gapic/stream_input.rb
gapic-common-0.16.0 lib/gapic/stream_input.rb
gapic-common-0.15.1 lib/gapic/stream_input.rb
gapic-common-0.15.0 lib/gapic/stream_input.rb
gapic-common-0.14.0 lib/gapic/stream_input.rb
gapic-common-0.13.0 lib/gapic/stream_input.rb
gapic-common-0.12.0 lib/gapic/stream_input.rb
gapic-common-0.11.1 lib/gapic/stream_input.rb
gapic-common-0.11.0 lib/gapic/stream_input.rb