Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for IO#timeout. #714

Merged
merged 5 commits into from
Jan 17, 2024
Merged

Add support for IO#timeout. #714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
455c1d6
Add support for IO#timeout.
ioquatix Jan 13, 2024
a9eec79
Prefer checking for `rb_io_timeout`.
ioquatix Jan 13, 2024
135e2b2
Ensure connection is closed for windows?
ioquatix Jan 13, 2024
f29a31f
Try to do a bit more for windows?
ioquatix Jan 13, 2024
898f3bc
Increase timeout.
ioquatix Jan 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ext/openssl/extconf.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@

have_func("rb_io_descriptor")
have_func("rb_io_maybe_wait(0, Qnil, Qnil, Qnil)", "ruby/io.h") # Ruby 3.1
have_func("rb_io_timeout", "ruby/io.h")

Logging::message "=== Checking for system dependent stuff... ===\n"
have_library("nsl", "t_open")
Expand Down
15 changes: 13 additions & 2 deletions ext/openssl/ossl_ssl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1725,11 +1725,20 @@ no_exception_p(VALUE opts)
#define RUBY_IO_TIMEOUT_DEFAULT Qnil
#endif

#ifdef HAVE_RB_IO_TIMEOUT
#define IO_TIMEOUT_ERROR rb_eIOTimeoutError
#else
#define IO_TIMEOUT_ERROR rb_eIOError
#endif


static void
io_wait_writable(VALUE io)
{
#ifdef HAVE_RB_IO_MAYBE_WAIT
rb_io_maybe_wait_writable(errno, io, RUBY_IO_TIMEOUT_DEFAULT);
if (!rb_io_maybe_wait_writable(errno, io, RUBY_IO_TIMEOUT_DEFAULT)) {
rb_raise(IO_TIMEOUT_ERROR, "Timed out while waiting to become writable!");
}
#else
rb_io_t *fptr;
GetOpenFile(io, fptr);
Expand All @@ -1741,7 +1750,9 @@ static void
io_wait_readable(VALUE io)
{
#ifdef HAVE_RB_IO_MAYBE_WAIT
rb_io_maybe_wait_readable(errno, io, RUBY_IO_TIMEOUT_DEFAULT);
if (!rb_io_maybe_wait_readable(errno, io, RUBY_IO_TIMEOUT_DEFAULT)) {
rb_raise(IO_TIMEOUT_ERROR, "Timed out while waiting to become readable!");
}
#else
rb_io_t *fptr;
GetOpenFile(io, fptr);
Expand Down
10 changes: 10 additions & 0 deletions lib/openssl/ssl.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,16 @@ def wait_readable(*args)
def wait_writable(*args)
to_io.wait_writable(*args)
end

if IO.method_defined?(:timeout)
def timeout
to_io.timeout
end

def timeout=(value)
to_io.timeout=(value)
end
end
end

def verify_certificate_identity(cert, hostname)
Expand Down
18 changes: 18 additions & 0 deletions test/openssl/test_ssl.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,24 @@ def test_sysread_and_syswrite
}
end

def test_read_with_timeout
omit "does not support timeout" unless IO.method_defined?(:timeout)

start_server do |port|
server_connect(port) do |ssl|
str = +("x" * 100 + "\n")
ssl.syswrite(str)
assert_equal(str, ssl.sysread(str.bytesize))

ssl.timeout = 1
assert_raise(IO::TimeoutError) {ssl.read(1)}

ssl.syswrite(str)
assert_equal(str, ssl.sysread(str.bytesize))
end
end
end

def test_getbyte
start_server { |port|
server_connect(port) { |ssl|
Expand Down