Class: Protocol::HTTP::Body::Stream

Inherits:
Object
  • Object
show all
Defined in:
lib/protocol/http/body/stream.rb

Overview

The input stream is an IO-like object which contains the raw HTTP POST data. When applicable, its external encoding must be “ASCII-8BIT” and it must be opened in binary mode, for Ruby 1.9 compatibility. The input stream must respond to gets, each, read and rewind.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(input, output) ⇒ Stream

Returns a new instance of Stream.


28
29
30
31
32
33
34
35
# File 'lib/protocol/http/body/stream.rb', line 28

def initialize(input, output)
	@input = input
	@output = output
	
	# Will hold remaining data in `#read`.
	@buffer = nil
	@closed = false
end

Instance Attribute Details

#inputObject (readonly)

Returns the value of attribute input


37
38
39
# File 'lib/protocol/http/body/stream.rb', line 37

def input
  @input
end

#outputObject (readonly)

Returns the value of attribute output


38
39
40
# File 'lib/protocol/http/body/stream.rb', line 38

def output
  @output
end

Instance Method Details

#closeObject

Close the input and output bodies.


115
116
117
118
119
120
# File 'lib/protocol/http/body/stream.rb', line 115

def close
	self.close_read
	self.close_write
ensure
	@closed = true
end

#close_readObject


105
106
107
# File 'lib/protocol/http/body/stream.rb', line 105

def close_read
	@input&.close
end

#close_writeObject

close must never be called on the input stream. huh?


110
111
112
# File 'lib/protocol/http/body/stream.rb', line 110

def close_write
	@output&.close
end

#closed?Boolean

Whether the stream has been closed.

Returns:

  • (Boolean)

123
124
125
# File 'lib/protocol/http/body/stream.rb', line 123

def closed?
	@closed
end

#empty?Boolean

Whether there are any output chunks remaining?

Returns:

  • (Boolean)

128
129
130
# File 'lib/protocol/http/body/stream.rb', line 128

def empty?
	@output.empty?
end

#flushObject


102
103
# File 'lib/protocol/http/body/stream.rb', line 102

def flush
end

#read(length = nil, buffer = nil) ⇒ Object

read behaves like IO#read. Its signature is read([length, [buffer]]). If given, length must be a non-negative Integer (>= 0) or nil, and buffer must be a String and may not be nil. If length is given and not nil, then this method reads at most length bytes from the input stream. If length is not given or nil, then this method reads all data until EOF. When EOF is reached, this method returns nil if length is given and not nil, or “” if length is not given or is nil. If buffer is given, then the read data will be placed into buffer instead of a newly created String object.

Parameters:

  • length (Integer) (defaults to: nil)

    the amount of data to read

  • buffer (String) (defaults to: nil)

    the buffer which will receive the data

Returns:

  • a buffer containing the data


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/protocol/http/body/stream.rb', line 47

def read(length = nil, buffer = nil)
	buffer ||= Async::IO::Buffer.new
	buffer.clear
	
	until buffer.bytesize == length
		@buffer = read_next if @buffer.nil?
		break if @buffer.nil?
		
		remaining_length = length - buffer.bytesize if length
		
		if remaining_length && remaining_length < @buffer.bytesize
			# We know that we are not going to reuse the original buffer.
			# But byteslice will generate a hidden copy. So let's freeze it first:
			@buffer.freeze
			
			buffer << @buffer.byteslice(0, remaining_length)
			@buffer = @buffer.byteslice(remaining_length, @buffer.bytesize)
		else
			buffer << @buffer
			@buffer = nil
		end
	end
	
	return nil if buffer.empty? && length && length > 0
	
	return buffer
end

#read_nonblock(length, buffer = nil) ⇒ Object


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/protocol/http/body/stream.rb', line 75

def read_nonblock(length, buffer = nil)
	@buffer ||= read_next
	chunk = nil
	
	if @buffer.bytesize > length
		chunk = @buffer.byteslice(0, length)
		@buffer = @buffer.byteslice(length, @buffer.bytesize)
	else
		chunk = @buffer
		@buffer = nil
	end
	
	if buffer
		buffer.replace(chunk)
	else
		buffer = chunk
	end
	
	return buffer
end

#write(buffer) ⇒ Object Also known as: write_nonblock


96
97
98
# File 'lib/protocol/http/body/stream.rb', line 96

def write(buffer)
	@output.write(buffer)
end