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.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


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

def @@j_api_type.accept?(obj)
  obj.class == HttpClient
end

+ (Object) j_api_type



57
58
59
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 57

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



60
61
62
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 60

def self.j_class
  Java::IoVertxCoreHttp::HttpClient.java_class
end

+ (Object) unwrap(obj)



54
55
56
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 54

def @@j_api_type.unwrap(obj)
  obj.j_del
end

+ (Object) wrap(obj)



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

def @@j_api_type.wrap(obj)
  HttpClient.new(obj)
end

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)


1062
1063
1064
1065
1066
1067
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 1062

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

- (::Vertx::HttpClientRequest) delete(options) - (::Vertx::HttpClientRequest) delete(requestURI) - (::Vertx::HttpClientRequest) delete(host, requestURI) - (::Vertx::HttpClientRequest) delete(options, responseHandler) { ... } - (::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(options)

    Parameters:

    • options (Hash)
      the request options
  • - (::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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (::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)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 583

def delete(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:delete, [Java::IoVertxCoreHttp::RequestOptions.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1))),::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]).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 == Hash && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:delete, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::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)


608
609
610
611
612
613
614
615
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 608

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(options) - (::Vertx::HttpClientRequest) get(requestURI) - (::Vertx::HttpClientRequest) get(host, requestURI) - (::Vertx::HttpClientRequest) get(options, responseHandler) { ... } - (::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(options)

    Parameters:

    • options (Hash)
      the request options
  • - (::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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (::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)


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 171

def get(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:get, [Java::IoVertxCoreHttp::RequestOptions.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1))),::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]).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 == Hash && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:get, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::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)


196
197
198
199
200
201
202
203
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 196

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(options, responseHandler) { ... } - (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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (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)


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

def get_now(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && block_given? && param_2 == nil && param_3 == nil
    @j_del.java_method(:getNow, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif 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(options) - (::Vertx::HttpClientRequest) head(requestURI) - (::Vertx::HttpClientRequest) head(host, requestURI) - (::Vertx::HttpClientRequest) head(options, responseHandler) { ... } - (::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(options)

    Parameters:

    • options (Hash)
      the request options
  • - (::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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (::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)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 329

def head(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:head, [Java::IoVertxCoreHttp::RequestOptions.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1))),::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]).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 == Hash && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:head, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::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)


354
355
356
357
358
359
360
361
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 354

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(options, responseHandler) { ... } - (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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (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)


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 380

def head_now(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && block_given? && param_2 == nil && param_3 == nil
    @j_del.java_method(:headNow, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif 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)


65
66
67
68
69
70
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 65

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(options) - (::Vertx::HttpClientRequest) options(requestURI) - (::Vertx::HttpClientRequest) options(host, requestURI) - (::Vertx::HttpClientRequest) options(options, responseHandler) { ... } - (::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(options)

    Parameters:

    • options (Hash)
      the request options
  • - (::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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (::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)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 425

def options(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:options, [Java::IoVertxCoreHttp::RequestOptions.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1))),::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]).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 == Hash && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:options, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::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)


450
451
452
453
454
455
456
457
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 450

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(options, responseHandler) { ... } - (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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (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)


476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 476

def options_now(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && block_given? && param_2 == nil && param_3 == nil
    @j_del.java_method(:optionsNow, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) }))
    return self
  elsif 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(options) - (::Vertx::HttpClientRequest) post(requestURI) - (::Vertx::HttpClientRequest) post(host, requestURI) - (::Vertx::HttpClientRequest) post(options, responseHandler) { ... } - (::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(options)

    Parameters:

    • options (Hash)
      the request options
  • - (::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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (::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)


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

def post(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:post, [Java::IoVertxCoreHttp::RequestOptions.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1))),::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]).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 == Hash && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:post, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::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)


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

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(options) - (::Vertx::HttpClientRequest) put(requestURI) - (::Vertx::HttpClientRequest) put(host, requestURI) - (::Vertx::HttpClientRequest) put(options, responseHandler) { ... } - (::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(options)

    Parameters:

    • options (Hash)
      the request options
  • - (::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(options, responseHandler) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

    • the response handler
  • - (::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)


521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 521

def put(param_1=nil,param_2=nil,param_3=nil)
  if param_1.class == Hash && !block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:put, [Java::IoVertxCoreHttp::RequestOptions.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1))),::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]).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 == Hash && block_given? && param_2 == nil && param_3 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:put, [Java::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::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)


546
547
548
549
550
551
552
553
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 546

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

- (self) redirect_handler(handler = nil) { ... }

Set a redirect handler for the http client.

The redirect handler is called when a 3xx response is received and the request is configured to follow redirects with Vertx::HttpClientRequest#set_follow_redirects.

The redirect handler is passed the Vertx::HttpClientResponse, it can return an Vertx::HttpClientRequest or null.

  • when null is returned, the original response is processed by the original request response handler
  • when a new Future is returned, the client will send this new request
The handler must return a Future unsent so the client can further configure it and send it.

Yields:

  • the new redirect handler

Returns:

  • (self)

Raises:

  • (ArgumentError)


1052
1053
1054
1055
1056
1057
1058
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 1052

def redirect_handler(handler=nil)
  if block_given? && handler == nil
    @j_del.java_method(:redirectHandler, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)).j_del }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling redirect_handler(#{handler})"
end

- (::Vertx::HttpClientRequest) request(method, options) - (::Vertx::HttpClientRequest) request(method, requestURI) - (::Vertx::HttpClientRequest) request(method, host, requestURI) - (::Vertx::HttpClientRequest) request(method, options, responseHandler) { ... } - (::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, options)

    Parameters:

    • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
      the HTTP method
    • options (Hash)
      the request options
  • - (::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, options, responseHandler) { ... }

    Parameters:

    • method (:OPTIONS, :GET, :HEAD, :POST, :PUT, :DELETE, :TRACE, :CONNECT, :PATCH, :OTHER)
      the HTTP method
    • options (Hash)
      the request options

    Yields:

  • - (::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)


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 108

def request(param_1=nil,param_2=nil,param_3=nil,param_4=nil)
  if param_1.class == Symbol && param_2.class == Hash && !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::IoVertxCoreHttp::RequestOptions.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1.to_s),Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_2))),::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]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1.to_s),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.to_s),param_2,param_3),::Vertx::HttpClientRequest)
  elsif param_1.class == Symbol && param_2.class == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::HttpMethod.valueOf(param_1.to_s),Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_2)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpClientResponse)) })),::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.to_s),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.to_s),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.to_s),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.to_s),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)


134
135
136
137
138
139
140
141
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 134

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.to_s),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.to_s),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(options, wsConnect) { ... } - (self) websocket(requestURI, wsConnect) { ... } - (self) websocket(options, wsConnect, failureHandler) { ... } - (self) websocket(host, requestURI, wsConnect) { ... } - (self) websocket(options, headers, 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(options, headers, wsConnect, failureHandler) { ... } - (self) websocket(host, requestURI, headers, wsConnect) { ... } - (self) websocket(options, headers, version, 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(options, headers, version, wsConnect, failureHandler) { ... } - (self) websocket(host, requestURI, headers, version, wsConnect) { ... } - (self) websocket(options, headers, version, subProtocols, 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(options, headers, version, subProtocols, 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(options, wsConnect) { ... }

    Parameters:

    • options (Hash)
      the request options

    Yields:

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

    Parameters:

    • requestURI (String)
      the relative URI

    Yields:

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

    Parameters:

    • options (Hash)
      the request options
    • 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, wsConnect) { ... }

    Parameters:

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

    Yields:

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

    Parameters:

    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(options, headers, wsConnect, failureHandler) { ... }

    Parameters:

    • options (Hash)
      the request options
    • 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, 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(options, headers, version, wsConnect) { ... }

    Parameters:

    • options (Hash)
      the request options
    • 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, 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(options, headers, version, wsConnect, failureHandler) { ... }

    Parameters:

    • options (Hash)
      the request options
    • 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, 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(options, headers, version, subProtocols, wsConnect) { ... }

    Parameters:

    • options (Hash)
      the request options
    • 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, 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(options, headers, version, subProtocols, wsConnect, failureHandler) { ... }

    Parameters:

    • options (Hash)
      the request options
    • 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(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)


803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 803

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 == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif 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 == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(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 == 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 == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),param_2.j_del,(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 == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(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 == 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 == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3.to_s),(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.to_s),(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 == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3.to_s),(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.to_s),(Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocket)) }))
    return self
  elsif param_1.class == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3.to_s),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.to_s),(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.to_s),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.to_s),(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.to_s),(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 == Hash && 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::IoVertxCoreHttp::RequestOptions.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(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3.to_s),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.to_s),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.to_s),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.to_s),(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.to_s),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.to_s),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.to_s),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

- (self) websocket_abs(url = nil, headers = nil, version = nil, subProtocols = nil, wsConnect = nil) { ... }

Connect a WebSocket with the specified absolute url, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols.

Parameters:

  • url (String) (defaults to: nil)
    the absolute url
  • headers (::Vertx::MultiMap) (defaults to: nil)
    the headers
  • version (:V00, :V07, :V08, :V13) (defaults to: nil)
    the websocket version
  • subProtocols (String) (defaults to: nil)
    the subprotocols to use
  • wsConnect (Proc) (defaults to: nil)
    handler that will be called with the websocket when connected

Yields:

  • handler that will be called if websocket connection fails

Returns:

  • (self)

Raises:

  • (ArgumentError)


912
913
914
915
916
917
918
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 912

def websocket_abs(url=nil,headers=nil,version=nil,subProtocols=nil,wsConnect=nil)
  if url.class == String && headers.class.method_defined?(:j_del) && version.class == Symbol && subProtocols.class == String && wsConnect.class == Proc && block_given?
    @j_del.java_method(:websocketAbs, [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(url,headers.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(version.to_s),subProtocols,(Proc.new { |event| wsConnect.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_abs(#{url},#{headers},#{version},#{subProtocols},#{wsConnect})"
end

- (::Vertx::ReadStream) websocketStream(options) - (::Vertx::ReadStream) websocketStream(requestURI) - (::Vertx::ReadStream) websocketStream(host, requestURI) - (::Vertx::ReadStream) websocketStream(options, headers) - (::Vertx::ReadStream) websocketStream(requestURI, headers) - (::Vertx::ReadStream) websocketStream(port, host, requestURI) - (::Vertx::ReadStream) websocketStream(host, requestURI, headers) - (::Vertx::ReadStream) websocketStream(options, headers, version) - (::Vertx::ReadStream) websocketStream(requestURI, headers, version) - (::Vertx::ReadStream) websocketStream(port, host, requestURI, headers) - (::Vertx::ReadStream) websocketStream(host, requestURI, headers, version) - (::Vertx::ReadStream) websocketStream(options, headers, version, subProtocols) - (::Vertx::ReadStream) websocketStream(requestURI, headers, version, subProtocols) - (::Vertx::ReadStream) websocketStream(port, host, requestURI, headers, version) - (::Vertx::ReadStream) websocketStream(host, requestURI, headers, version, subProtocols) - (::Vertx::ReadStream) 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::ReadStream) websocketStream(options)

    Parameters:

    • options (Hash)
      the request options
  • - (::Vertx::ReadStream) websocketStream(requestURI)

    Parameters:

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

    Parameters:

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

    Parameters:

  • - (::Vertx::ReadStream) websocketStream(requestURI, headers)

    Parameters:

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

    Parameters:

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

    Parameters:

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

    Parameters:

    • options (Hash)
      the request options
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
  • - (::Vertx::ReadStream) websocketStream(requestURI, headers, version)

    Parameters:

    • requestURI (String)
      the relative URI
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
  • - (::Vertx::ReadStream) 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::ReadStream) 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::ReadStream) websocketStream(options, headers, version, subProtocols)

    Parameters:

    • options (Hash)
      the request options
    • headers (::Vertx::MultiMap)
      the headers
    • version (:V00, :V07, :V08, :V13)
      the websocket version
    • subProtocols (String)
      the subprotocols to use
  • - (::Vertx::ReadStream) 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::ReadStream) 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::ReadStream) 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::ReadStream) 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)


990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 990

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 == Hash && !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::IoVertxCoreHttp::RequestOptions.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1))),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  elsif 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::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  elsif param_1.class == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::MultiMap.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),param_2.j_del),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  elsif param_1.class == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3.to_s)),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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.to_s)),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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.to_s)),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  elsif param_1.class == Hash && 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::IoVertxCoreHttp::RequestOptions.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class]).call(Java::IoVertxCoreHttp::RequestOptions.new(::Vertx::Util::Utils.to_json_object(param_1)),param_2.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(param_3.to_s),param_4),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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.to_s),param_4),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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.to_s)),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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.to_s),param_5),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  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.to_s),param_6),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  end
  raise ArgumentError, "Invalid arguments when calling websocket_stream(#{param_1},#{param_2},#{param_3},#{param_4},#{param_5},#{param_6})"
end

- (::Vertx::ReadStream) websocket_stream_abs(url = nil, headers = nil, version = nil, subProtocols = nil)

Create a WebSocket stream with the specified absolute url, the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols.

Parameters:

  • url (String) (defaults to: nil)
    the absolute url
  • headers (::Vertx::MultiMap) (defaults to: nil)
    the headers
  • version (:V00, :V07, :V08, :V13) (defaults to: nil)
    the websocket version
  • subProtocols (String) (defaults to: nil)
    the subprotocols to use

Returns:

Raises:

  • (ArgumentError)


1033
1034
1035
1036
1037
1038
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client.rb', line 1033

def websocket_stream_abs(url=nil,headers=nil,version=nil,subProtocols=nil)
  if url.class == String && headers.class.method_defined?(:j_del) && version.class == Symbol && subProtocols.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStreamAbs, [Java::java.lang.String.java_class,Java::IoVertxCore::MultiMap.java_class,Java::IoVertxCoreHttp::WebsocketVersion.java_class,Java::java.lang.String.java_class]).call(url,headers.j_del,Java::IoVertxCoreHttp::WebsocketVersion.valueOf(version.to_s),subProtocols),::Vertx::ReadStreamImpl,::Vertx::WebSocket.j_api_type)
  end
  raise ArgumentError, "Invalid arguments when calling websocket_stream_abs(#{url},#{headers},#{version},#{subProtocols})"
end