Class: Vertx::HttpClient

Inherits:
Object
  • Object
show all
Includes:
Measured
Defined in:
/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb

Overview

An asynchronous HTTP client.

It allows you to make requests to HTTP servers, and a single client can make requests to any server.

It also allows you to open WebSockets to servers.

The client can also pool HTTP connections.

For pooling to occur, keep-alive must be true on the Hash (default is true). In this case connections will be pooled and re-used if there are pending HTTP requests waiting to get a connection, otherwise they will be closed.

This gives the benefits of keep alive when the client is loaded but means we don't keep connections hanging around unnecessarily when there would be no benefits anyway.

The client also supports pipe-lining of requests. Pipe-lining means another request is sent on the same connection before the response from the preceding one has returned. Pipe-lining is not appropriate for all requests.

To enable pipe-lining, it must be enabled on the Hash (default is false).

When pipe-lining is enabled the connection will be automatically closed when all in-flight responses have returned and there are no outstanding pending requests to write.

The client is designed to be reused between requests.

Instance Method Summary (collapse)

Instance Method Details

- (void) close

This method returns an undefined value.

Close the client. Closing will close down any pooled connections. Clients should always be closed after use.

Raises:

  • (ArgumentError)


827
828
829
830
831
832
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 827

def close
  if !block_given?
    return @j_del.java_method(:close, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling close()"
end

- (::Vertx::HttpClientRequest) delete(requestURI) - (::Vertx::HttpClientRequest) delete(host, requestURI) - (::Vertx::HttpClientRequest) delete(requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) delete(port, host, requestURI) - (::Vertx::HttpClientRequest) delete(host, requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) delete(port, host, requestURI, responseHandler) { ... }

Create an HTTP DELETE request to send to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (::Vertx::HttpClientRequest) delete(requestURI)

    Parameters:

    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) delete(host, requestURI)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) delete(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) delete(port, host, requestURI)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) delete(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) delete(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

Raises:

  • (ArgumentError)


487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 487

def delete(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:delete, [Java::java.lang.String.java_class]).call(param_1),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && !block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:delete, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2),::Vertx::HttpClientRequest)
  elsif param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:delete, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:delete, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:delete, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:delete, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling delete(param_1,param_2,param_3)"
end

- (::Vertx::HttpClientRequest) delete_abs(absoluteURI = nil) { ... }

Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

  • absoluteURI (String) (defaults to: nil)
    the absolute URI

Yields:

  • the response handler

Returns:

Raises:

  • (ArgumentError)


508
509
510
511
512
513
514
515
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 508

def delete_abs(absoluteURI=nil)
  if absoluteURI.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:deleteAbs, [Java::java.lang.String.java_class]).call(absoluteURI),::Vertx::HttpClientRequest)
  elsif absoluteURI.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:deleteAbs, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(absoluteURI,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling delete_abs(absoluteURI)"
end

- (::Vertx::HttpClientRequest) get(requestURI) - (::Vertx::HttpClientRequest) get(host, requestURI) - (::Vertx::HttpClientRequest) get(requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) get(port, host, requestURI) - (::Vertx::HttpClientRequest) get(host, requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) get(port, host, requestURI, responseHandler) { ... }

Create an HTTP GET request to send to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (::Vertx::HttpClientRequest) get(requestURI)

    Parameters:

    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) get(host, requestURI)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) get(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) get(port, host, requestURI)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) get(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) get(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

Raises:

  • (ArgumentError)


138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 138

def get(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:get, [Java::java.lang.String.java_class]).call(param_1),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && !block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:get, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2),::Vertx::HttpClientRequest)
  elsif param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:get, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:get, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:get, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:get, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling get(param_1,param_2,param_3)"
end

- (::Vertx::HttpClientRequest) get_abs(absoluteURI = nil) { ... }

Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

  • absoluteURI (String) (defaults to: nil)
    the absolute URI

Yields:

  • the response handler

Returns:

Raises:

  • (ArgumentError)


159
160
161
162
163
164
165
166
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 159

def get_abs(absoluteURI=nil)
  if absoluteURI.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:getAbs, [Java::java.lang.String.java_class]).call(absoluteURI),::Vertx::HttpClientRequest)
  elsif absoluteURI.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:getAbs, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(absoluteURI,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling get_abs(absoluteURI)"
end

- (self) getNow(requestURI, responseHandler) { ... } - (self) getNow(host, requestURI, responseHandler) { ... } - (self) getNow(port, host, requestURI, responseHandler) { ... }

Sends an HTTP GET request to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (self) getNow(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (self) getNow(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (self) getNow(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

  • (self)

Raises:

  • (ArgumentError)


182
183
184
185
186
187
188
189
190
191
192
193
194
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 182

def get_now(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    @j_del.java_method(:getNow, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    @j_del.java_method(:getNow, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    @j_del.java_method(:getNow, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling get_now(param_1,param_2,param_3)"
end

- (::Vertx::HttpClientRequest) head(requestURI) - (::Vertx::HttpClientRequest) head(host, requestURI) - (::Vertx::HttpClientRequest) head(requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) head(port, host, requestURI) - (::Vertx::HttpClientRequest) head(host, requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) head(port, host, requestURI, responseHandler) { ... }

Create an HTTP HEAD request to send to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (::Vertx::HttpClientRequest) head(requestURI)

    Parameters:

    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) head(host, requestURI)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) head(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) head(port, host, requestURI)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) head(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) head(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

Raises:

  • (ArgumentError)


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 272

def head(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:head, [Java::java.lang.String.java_class]).call(param_1),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && !block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:head, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2),::Vertx::HttpClientRequest)
  elsif param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:head, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:head, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:head, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:head, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling head(param_1,param_2,param_3)"
end

- (::Vertx::HttpClientRequest) head_abs(absoluteURI = nil) { ... }

Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

  • absoluteURI (String) (defaults to: nil)
    the absolute URI

Yields:

  • the response handler

Returns:

Raises:

  • (ArgumentError)


293
294
295
296
297
298
299
300
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 293

def head_abs(absoluteURI=nil)
  if absoluteURI.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:headAbs, [Java::java.lang.String.java_class]).call(absoluteURI),::Vertx::HttpClientRequest)
  elsif absoluteURI.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:headAbs, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(absoluteURI,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling head_abs(absoluteURI)"
end

- (self) headNow(requestURI, responseHandler) { ... } - (self) headNow(host, requestURI, responseHandler) { ... } - (self) headNow(port, host, requestURI, responseHandler) { ... }

Sends an HTTP HEAD request to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (self) headNow(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (self) headNow(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (self) headNow(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

  • (self)

Raises:

  • (ArgumentError)


316
317
318
319
320
321
322
323
324
325
326
327
328
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 316

def head_now(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    @j_del.java_method(:headNow, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    @j_del.java_method(:headNow, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    @j_del.java_method(:headNow, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling head_now(param_1,param_2,param_3)"
end

- (true, false) metrics_enabled?

Whether the metrics are enabled for this measured object

Returns:

  • (true, false)
    true if the metrics are enabled

Raises:

  • (ArgumentError)


48
49
50
51
52
53
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 48

def metrics_enabled?
  if !block_given?
    return @j_del.java_method(:isMetricsEnabled, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling metrics_enabled?()"
end

- (::Vertx::HttpClientRequest) options(requestURI) - (::Vertx::HttpClientRequest) options(host, requestURI) - (::Vertx::HttpClientRequest) options(requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) options(port, host, requestURI) - (::Vertx::HttpClientRequest) options(host, requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) options(port, host, requestURI, responseHandler) { ... }

Create an HTTP OPTIONS request to send to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (::Vertx::HttpClientRequest) options(requestURI)

    Parameters:

    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) options(host, requestURI)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) options(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) options(port, host, requestURI)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) options(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) options(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

Raises:

  • (ArgumentError)


353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 353

def options(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:options, [Java::java.lang.String.java_class]).call(param_1),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && !block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:options, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2),::Vertx::HttpClientRequest)
  elsif param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:options, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:options, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:options, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:options, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling options(param_1,param_2,param_3)"
end

- (::Vertx::HttpClientRequest) options_abs(absoluteURI = nil) { ... }

Create an HTTP OPTIONS request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

  • absoluteURI (String) (defaults to: nil)
    the absolute URI

Yields:

  • the response handler

Returns:

Raises:

  • (ArgumentError)


374
375
376
377
378
379
380
381
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 374

def options_abs(absoluteURI=nil)
  if absoluteURI.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:optionsAbs, [Java::java.lang.String.java_class]).call(absoluteURI),::Vertx::HttpClientRequest)
  elsif absoluteURI.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:optionsAbs, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(absoluteURI,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling options_abs(absoluteURI)"
end

- (self) optionsNow(requestURI, responseHandler) { ... } - (self) optionsNow(host, requestURI, responseHandler) { ... } - (self) optionsNow(port, host, requestURI, responseHandler) { ... }

Sends an HTTP OPTIONS request to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (self) optionsNow(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (self) optionsNow(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (self) optionsNow(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

  • (self)

Raises:

  • (ArgumentError)


397
398
399
400
401
402
403
404
405
406
407
408
409
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 397

def options_now(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    @j_del.java_method(:optionsNow, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    @j_del.java_method(:optionsNow, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    @j_del.java_method(:optionsNow, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling options_now(param_1,param_2,param_3)"
end

- (::Vertx::HttpClientRequest) post(requestURI) - (::Vertx::HttpClientRequest) post(host, requestURI) - (::Vertx::HttpClientRequest) post(requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) post(port, host, requestURI) - (::Vertx::HttpClientRequest) post(host, requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) post(port, host, requestURI, responseHandler) { ... }

Create an HTTP POST request to send to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (::Vertx::HttpClientRequest) post(requestURI)

    Parameters:

    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) post(host, requestURI)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) post(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) post(port, host, requestURI)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) post(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) post(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

Raises:

  • (ArgumentError)


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 219

def post(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:post, [Java::java.lang.String.java_class]).call(param_1),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && !block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:post, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2),::Vertx::HttpClientRequest)
  elsif param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:post, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:post, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:post, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:post, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling post(param_1,param_2,param_3)"
end

- (::Vertx::HttpClientRequest) post_abs(absoluteURI = nil) { ... }

Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

  • absoluteURI (String) (defaults to: nil)
    the absolute URI

Yields:

  • the response handler

Returns:

Raises:

  • (ArgumentError)


240
241
242
243
244
245
246
247
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 240

def post_abs(absoluteURI=nil)
  if absoluteURI.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:postAbs, [Java::java.lang.String.java_class]).call(absoluteURI),::Vertx::HttpClientRequest)
  elsif absoluteURI.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:postAbs, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(absoluteURI,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling post_abs(absoluteURI)"
end

- (::Vertx::HttpClientRequest) put(requestURI) - (::Vertx::HttpClientRequest) put(host, requestURI) - (::Vertx::HttpClientRequest) put(requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) put(port, host, requestURI) - (::Vertx::HttpClientRequest) put(host, requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) put(port, host, requestURI, responseHandler) { ... }

Create an HTTP PUT request to send to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (::Vertx::HttpClientRequest) put(requestURI)

    Parameters:

    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) put(host, requestURI)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) put(requestURI, responseHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) put(port, host, requestURI)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) put(host, requestURI, responseHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) put(port, host, requestURI, responseHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

Raises:

  • (ArgumentError)


434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 434

def put(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == String && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:put, [Java::java.lang.String.java_class]).call(param_1),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && !block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:put, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2),::Vertx::HttpClientRequest)
  elsif param_1.class == String && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:put, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:put, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3),::Vertx::HttpClientRequest)
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:put, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:put, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling put(param_1,param_2,param_3)"
end

- (::Vertx::HttpClientRequest) put_abs(absoluteURI = nil) { ... }

Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

  • absoluteURI (String) (defaults to: nil)
    the absolute URI

Yields:

  • the response handler

Returns:

Raises:

  • (ArgumentError)


455
456
457
458
459
460
461
462
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 455

def put_abs(absoluteURI=nil)
  if absoluteURI.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:putAbs, [Java::java.lang.String.java_class]).call(absoluteURI),::Vertx::HttpClientRequest)
  elsif absoluteURI.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:putAbs, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(absoluteURI,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling put_abs(absoluteURI)"
end

- (::Vertx::HttpClientRequest) request(method, requestURI) - (::Vertx::HttpClientRequest) request(method, host, requestURI) - (::Vertx::HttpClientRequest) request(method, requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) request(method, port, host, requestURI) - (::Vertx::HttpClientRequest) request(method, host, requestURI, responseHandler) { ... } - (::Vertx::HttpClientRequest) request(method, port, host, requestURI, responseHandler) { ... }

Create an HTTP request to send to the server at the specified host and port, specifying a response handler to receive the response

Overloads:

  • - (::Vertx::HttpClientRequest) request(method, requestURI)

    Parameters:

    • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
      the HTTP method
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) request(method, host, requestURI)

    Parameters:

    • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
      the HTTP method
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) request(method, requestURI, responseHandler) { ... }

    Parameters:

    • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
      the HTTP method
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) request(method, port, host, requestURI)

    Parameters:

    • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
      the HTTP method
    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::HttpClientRequest) request(method, host, requestURI, responseHandler) { ... }

    Parameters:

    • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
      the HTTP method
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler
  • - (::Vertx::HttpClientRequest) request(method, port, host, requestURI, responseHandler) { ... }

    Parameters:

    • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
      the HTTP method
    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • the response handler

Returns:

Raises:

  • (ArgumentError)


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 84

def request(param_1=nil,param_2=nil,param_3=nil,param_4=nil)
  if param_1.class == Symbol && param_2.class == String && !block_given? && param_3 == nil && param_4 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:request, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::java.lang.String.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1),param_2),::Vertx::HttpClientRequest)
  elsif param_1.class == Symbol && param_2.class == String && param_3.class == String && !block_given? && param_4 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:request, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1),param_2,param_3),::Vertx::HttpClientRequest)
  elsif param_1.class == Symbol && param_2.class == String && block_given? && param_3 == nil && param_4 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:request, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1),param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Symbol && param_2.class == Fixnum && param_3.class == String && param_4.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:request, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1),param_2,param_3,param_4),::Vertx::HttpClientRequest)
  elsif param_1.class == Symbol && param_2.class == String && param_3.class == String && block_given? && param_4 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:request, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1),param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  elsif param_1.class == Symbol && param_2.class == Fixnum && param_3.class == String && param_4.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:request, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1),param_2,param_3,param_4,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling request(param_1,param_2,param_3,param_4)"
end

- (::Vertx::HttpClientRequest) request_abs(method = nil, absoluteURI = nil) { ... }

Create an HTTP request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

  • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER) (defaults to: nil)
    the HTTP method
  • absoluteURI (String) (defaults to: nil)
    the absolute URI

Yields:

  • the response handler

Returns:

Raises:

  • (ArgumentError)


106
107
108
109
110
111
112
113
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 106

def request_abs(method=nil,absoluteURI=nil)
  if method.class == Symbol && absoluteURI.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:requestAbs, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::java.lang.String.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(method),absoluteURI),::Vertx::HttpClientRequest)
  elsif method.class == Symbol && absoluteURI.class == String && block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:requestAbs, [Java::IoVertxCoreHttp::HttpMethod.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(method),absoluteURI,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::Vertx::HttpClientRequest)
  end
  raise ArgumentError, "Invalid arguments when calling request_abs(method,absoluteURI)"
end

- (self) websocket(requestURI, wsConnect) { ... } - (self) websocket(host, requestURI, wsConnect) { ... } - (self) websocket(requestURI, wsConnect, failureHandler) { ... } - (self) websocket(requestURI, headers, wsConnect) { ... } - (self) websocket(port, host, requestURI, wsConnect) { ... } - (self) websocket(host, requestURI, wsConnect, failureHandler) { ... } - (self) websocket(host, requestURI, headers, wsConnect) { ... } - (self) websocket(requestURI, headers, wsConnect, failureHandler) { ... } - (self) websocket(requestURI, headers, version, wsConnect) { ... } - (self) websocket(port, host, requestURI, wsConnect, failureHandler) { ... } - (self) websocket(port, host, requestURI, headers, wsConnect) { ... } - (self) websocket(host, requestURI, headers, wsConnect, failureHandler) { ... } - (self) websocket(host, requestURI, headers, version, wsConnect) { ... } - (self) websocket(requestURI, headers, version, wsConnect, failureHandler) { ... } - (self) websocket(requestURI, headers, version, subProtocols, wsConnect) { ... } - (self) websocket(port, host, requestURI, headers, wsConnect, failureHandler) { ... } - (self) websocket(port, host, requestURI, headers, version, wsConnect) { ... } - (self) websocket(host, requestURI, headers, version, wsConnect, failureHandler) { ... } - (self) websocket(host, requestURI, headers, version, subProtocols, wsConnect) { ... } - (self) websocket(requestURI, headers, version, subProtocols, wsConnect, failureHandler) { ... } - (self) websocket(port, host, requestURI, headers, version, wsConnect, failureHandler) { ... } - (self) websocket(port, host, requestURI, headers, version, subProtocols, wsConnect) { ... } - (self) websocket(host, requestURI, headers, version, subProtocols, wsConnect, failureHandler) { ... } - (self) websocket(port, host, requestURI, headers, version, subProtocols, wsConnect, failureHandler) { ... }

Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols

Overloads:

  • - (self) websocket(requestURI, wsConnect) { ... }

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(host, requestURI, wsConnect) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(requestURI, wsConnect, failureHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(requestURI, headers, wsConnect) { ... }

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(port, host, requestURI, wsConnect) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(host, requestURI, wsConnect, failureHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(host, requestURI, headers, wsConnect) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(requestURI, headers, wsConnect, failureHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(requestURI, headers, version, wsConnect) { ... }

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(port, host, requestURI, wsConnect, failureHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(port, host, requestURI, headers, wsConnect) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(host, requestURI, headers, wsConnect, failureHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(host, requestURI, headers, version, wsConnect) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(requestURI, headers, version, wsConnect, failureHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(requestURI, headers, version, subProtocols, wsConnect) { ... }

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(port, host, requestURI, headers, wsConnect, failureHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(port, host, requestURI, headers, version, wsConnect) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(host, requestURI, headers, version, wsConnect, failureHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(host, requestURI, headers, version, subProtocols, wsConnect) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols to use

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(requestURI, headers, version, subProtocols, wsConnect, failureHandler) { ... }

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(port, host, requestURI, headers, version, wsConnect, failureHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(port, host, requestURI, headers, version, subProtocols, wsConnect) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols to use

    Yields:

    • handler that will be called with the websocket when connected
  • - (self) websocket(host, requestURI, headers, version, subProtocols, wsConnect, failureHandler) { ... }

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols to use
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails
  • - (self) websocket(port, host, requestURI, headers, version, subProtocols, wsConnect, failureHandler) { ... }

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols to use
    • wsConnect (Proc)
      handler that will be called with the websocket when connected

    Yields:

    • handler that will be called if websocket connection fails

Returns:

  • (self)

Raises:

  • (ArgumentError)


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 663

def websocket(param_1=nil,param_2=nil,param_3=nil,param_4=nil,param_5=nil,param_6=nil,param_7=nil)
  if param_1.class == String && block_given? && param_2 == nil && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class == String && block_given? && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class == Proc && block_given? && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,(Proc.new { |event| param_2.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && block_given? && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2.j_del,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && block_given? && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class == String && param_3.class == Proc && block_given? && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,(Proc.new { |event| param_3.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && block_given? && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3.j_del,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && param_3.class == Proc && block_given? && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2.j_del,(Proc.new { |event| param_3.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && param_3.class == Symbol && block_given? && param_4 == nil && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class == Proc && block_given? && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,(Proc.new { |event| param_4.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && block_given? && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,param_4.j_del,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && param_4.class == Proc && block_given? && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3.j_del,(Proc.new { |event| param_4.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && param_4.class == Symbol && block_given? && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_4),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && param_3.class == Symbol && param_4.class == Proc && block_given? && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3),(Proc.new { |event| param_4.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && param_3.class == Symbol && param_4.class == String && block_given? && param_5 == nil && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3),param_4,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && param_5.class == Proc && block_given? && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,param_4.j_del,(Proc.new { |event| param_5.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && param_5.class == Symbol && block_given? && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,param_4.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_5),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && param_4.class == Symbol && param_5.class == Proc && block_given? && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_4),(Proc.new { |event| param_5.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && param_4.class == Symbol && param_5.class == String && block_given? && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_4),param_5,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && param_3.class == Symbol && param_4.class == String && param_5.class == Proc && block_given? && param_6 == nil && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3),param_4,(Proc.new { |event| param_5.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && param_5.class == Symbol && param_6.class == Proc && block_given? && param_7 == nil
    @j_del.java_method(:websocket, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,param_4.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_5),(Proc.new { |event| param_6.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && param_5.class == Symbol && param_6.class == String && block_given? && param_7 == nil
    @j_del.java_method(:websocket, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,param_4.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_5),param_6,(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && param_4.class == Symbol && param_5.class == String && param_6.class == Proc && block_given? && param_7 == nil
    @j_del.java_method(:websocket, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_4),param_5,(Proc.new { |event| param_6.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && param_5.class == Symbol && param_6.class == String && param_7.class == Proc && block_given?
    @j_del.java_method(:websocket, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(param_1,param_2,param_3,param_4.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_5),param_6,(Proc.new { |event| param_7.call(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }),(Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling websocket(param_1,param_2,param_3,param_4,param_5,param_6,param_7)"
end

- (::Vertx::WebSocketStream) websocketStream(requestURI) - (::Vertx::WebSocketStream) websocketStream(host, requestURI) - (::Vertx::WebSocketStream) websocketStream(requestURI, headers) - (::Vertx::WebSocketStream) websocketStream(port, host, requestURI) - (::Vertx::WebSocketStream) websocketStream(host, requestURI, headers) - (::Vertx::WebSocketStream) websocketStream(requestURI, headers, version) - (::Vertx::WebSocketStream) websocketStream(port, host, requestURI, headers) - (::Vertx::WebSocketStream) websocketStream(host, requestURI, headers, version) - (::Vertx::WebSocketStream) websocketStream(requestURI, headers, version, subProtocols) - (::Vertx::WebSocketStream) websocketStream(port, host, requestURI, headers, version) - (::Vertx::WebSocketStream) websocketStream(host, requestURI, headers, version, subProtocols) - (::Vertx::WebSocketStream) websocketStream(port, host, requestURI, headers, version, subProtocols)

Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols

Overloads:

  • - (::Vertx::WebSocketStream) websocketStream(requestURI)

    Parameters:

    • requestURI (String)
      the relative URI
  • - (::Vertx::WebSocketStream) websocketStream(host, requestURI)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::WebSocketStream) websocketStream(requestURI, headers)

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
  • - (::Vertx::WebSocketStream) websocketStream(port, host, requestURI)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
  • - (::Vertx::WebSocketStream) websocketStream(host, requestURI, headers)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
  • - (::Vertx::WebSocketStream) websocketStream(requestURI, headers, version)

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
  • - (::Vertx::WebSocketStream) websocketStream(port, host, requestURI, headers)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
  • - (::Vertx::WebSocketStream) websocketStream(host, requestURI, headers, version)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
  • - (::Vertx::WebSocketStream) websocketStream(requestURI, headers, version, subProtocols)

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols
  • - (::Vertx::WebSocketStream) websocketStream(port, host, requestURI, headers, version)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
  • - (::Vertx::WebSocketStream) websocketStream(host, requestURI, headers, version, subProtocols)

    Parameters:

    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols to use
  • - (::Vertx::WebSocketStream) websocketStream(port, host, requestURI, headers, version, subProtocols)

    Parameters:

    • port (Fixnum)
      the port
    • host (String)
      the host
    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols to use

Returns:

Raises:

  • (ArgumentError)


796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 796

def websocket_stream(param_1=nil,param_2=nil,param_3=nil,param_4=nil,param_5=nil,param_6=nil)
  if param_1.class == String && !block_given? && param_2 == nil && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::java.lang.String.java_class]).call(param_1),::Vertx::WebSocketStream)
  elsif param_1.class == String && param_2.class == String && !block_given? && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2),::Vertx::WebSocketStream)
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && !block_given? && param_3 == nil && param_4 == nil && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class]).call(param_1,param_2.j_del),::Vertx::WebSocketStream)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && !block_given? && param_4 == nil && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3),::Vertx::WebSocketStream)
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && !block_given? && param_4 == nil && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class]).call(param_1,param_2,param_3.j_del),::Vertx::WebSocketStream)
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && param_3.class == Symbol && !block_given? && param_4 == nil && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class]).call(param_1,param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3)),::Vertx::WebSocketStream)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && !block_given? && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class]).call(param_1,param_2,param_3,param_4.j_del),::Vertx::WebSocketStream)
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && param_4.class == Symbol && !block_given? && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class]).call(param_1,param_2,param_3.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_4)),::Vertx::WebSocketStream)
  elsif param_1.class == String && param_2.class.method_defined?(:j_del) && param_3.class == Symbol && param_4.class == String && !block_given? && param_5 == nil && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class]).call(param_1,param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3),param_4),::Vertx::WebSocketStream)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && param_5.class == Symbol && !block_given? && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class]).call(param_1,param_2,param_3,param_4.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_5)),::Vertx::WebSocketStream)
  elsif param_1.class == String && param_2.class == String && param_3.class.method_defined?(:j_del) && param_4.class == Symbol && param_5.class == String && !block_given? && param_6 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_4),param_5),::Vertx::WebSocketStream)
  elsif param_1.class == Fixnum && param_2.class == String && param_3.class == String && param_4.class.method_defined?(:j_del) && param_5.class == Symbol && param_6.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, [Java::int.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class]).call(param_1,param_2,param_3,param_4.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_5),param_6),::Vertx::WebSocketStream)
  end
  raise ArgumentError, "Invalid arguments when calling websocket_stream(param_1,param_2,param_3,param_4,param_5,param_6)"
end