Class: VertxRedis::RedisClient

Inherits:
Object
  • Object
show all
Defined in:
/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


20
21
22
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 20

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

+ (::VertxRedis::RedisClient) create(vertx = nil, config = nil)

Parameters:

  • vertx (::Vertx::Vertx) (defaults to: nil)
  • config (Hash) (defaults to: nil)

Returns:

Raises:

  • (ArgumentError)


38
39
40
41
42
43
44
45
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 38

def self.create(vertx=nil,config=nil)
  if vertx.class.method_defined?(:j_del) && !block_given? && config == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxRedis::RedisClient.java_method(:create, [Java::IoVertxCore::Vertx.java_class]).call(vertx.j_del),::VertxRedis::RedisClient)
  elsif vertx.class.method_defined?(:j_del) && config.class == Hash && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxRedis::RedisClient.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::IoVertxRedis::RedisOptions.java_class]).call(vertx.j_del,Java::IoVertxRedis::RedisOptions.new(::Vertx::Util::Utils.to_json_object(config))),::VertxRedis::RedisClient)
  end
  raise ArgumentError, "Invalid arguments when calling create(#{vertx},#{config})"
end

+ (Object) j_api_type



29
30
31
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 29

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



32
33
34
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 32

def self.j_class
  Java::IoVertxRedis::RedisClient.java_class
end

+ (Object) unwrap(obj)



26
27
28
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 26

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

+ (Object) wrap(obj)



23
24
25
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 23

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

Instance Method Details

- (self) append(key = nil, value = nil) { ... }

Append a value to a key

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • value (String) (defaults to: nil)
    Value to append

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


60
61
62
63
64
65
66
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 60

def append(key=nil,value=nil)
  if key.class == String && value.class == String && block_given?
    @j_del.java_method(:append, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling append(#{key},#{value})"
end

- (self) auth(password = nil) { ... }

Authenticate to the server

Parameters:

  • password (String) (defaults to: nil)
    Password for authentication

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


71
72
73
74
75
76
77
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 71

def auth(password=nil)
  if password.class == String && block_given?
    @j_del.java_method(:auth, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(password,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling auth(#{password})"
end

- (self) bgrewriteaof { ... }

Asynchronously rewrite the append-only file

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


81
82
83
84
85
86
87
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 81

def bgrewriteaof
  if block_given?
    @j_del.java_method(:bgrewriteaof, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bgrewriteaof()"
end

- (self) bgsave { ... }

Asynchronously save the dataset to disk

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


91
92
93
94
95
96
97
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 91

def bgsave
  if block_given?
    @j_del.java_method(:bgsave, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bgsave()"
end

- (self) bitcount(key = nil) { ... }

Count set bits in a string

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


102
103
104
105
106
107
108
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 102

def bitcount(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:bitcount, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bitcount(#{key})"
end

- (self) bitcount_range(key = nil, start = nil, _end = nil) { ... }

Count set bits in a string

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • start (Fixnum) (defaults to: nil)
    Start index
  • _end (Fixnum) (defaults to: nil)
    End index

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


115
116
117
118
119
120
121
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 115

def bitcount_range(key=nil,start=nil,_end=nil)
  if key.class == String && start.class == Fixnum && _end.class == Fixnum && block_given?
    @j_del.java_method(:bitcountRange, [Java::java.lang.String.java_class,Java::long.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,start,_end,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bitcount_range(#{key},#{start},#{_end})"
end

- (self) bitfield(key = nil, bitFieldOptions = nil) { ... }

Perform arbitrary bitfield integer operations on strings.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • bitFieldOptions (Hash) (defaults to: nil)

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


2841
2842
2843
2844
2845
2846
2847
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2841

def bitfield(key=nil,bitFieldOptions=nil)
  if key.class == String && bitFieldOptions.class == Hash && block_given?
    @j_del.java_method(:bitfield, [Java::java.lang.String.java_class,Java::IoVertxRedisOp::BitFieldOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(key,Java::IoVertxRedisOp::BitFieldOptions.new(::Vertx::Util::Utils.to_json_object(bitFieldOptions)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bitfield(#{key},#{bitFieldOptions})"
end

- (self) bitfield_with_overflow(key = nil, commands = nil, overflow = nil) { ... }

Perform arbitrary bitfield integer operations on strings.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • commands (Hash) (defaults to: nil)
  • overflow (:WRAP, :SAT, :FAIL) (defaults to: nil)

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


2854
2855
2856
2857
2858
2859
2860
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2854

def bitfield_with_overflow(key=nil,commands=nil,overflow=nil)
  if key.class == String && commands.class == Hash && overflow.class == Symbol && block_given?
    @j_del.java_method(:bitfieldWithOverflow, [Java::java.lang.String.java_class,Java::IoVertxRedisOp::BitFieldOptions.java_class,Java::IoVertxRedisOp::BitFieldOverflowOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(key,Java::IoVertxRedisOp::BitFieldOptions.new(::Vertx::Util::Utils.to_json_object(commands)),Java::IoVertxRedisOp::BitFieldOverflowOptions.valueOf(overflow.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bitfield_with_overflow(#{key},#{commands},#{overflow})"
end

- (self) bitop(operation = nil, destkey = nil, keys = nil) { ... }

Perform bitwise operations between strings

Parameters:

  • operation (:AND, :OR, :XOR, :NOT) (defaults to: nil)
    Bitwise operation to perform
  • destkey (String) (defaults to: nil)
    Destination key where result is stored
  • keys (Array<String>) (defaults to: nil)
    List of keys on which to perform the operation

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


128
129
130
131
132
133
134
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 128

def bitop(operation=nil,destkey=nil,keys=nil)
  if operation.class == Symbol && destkey.class == String && keys.class == Array && block_given?
    @j_del.java_method(:bitop, [Java::IoVertxRedisOp::BitOperation.java_class,Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxRedisOp::BitOperation.valueOf(operation.to_s),destkey,keys.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bitop(#{operation},#{destkey},#{keys})"
end

- (self) bitpos(key = nil, bit = nil) { ... }

Find first bit set or clear in a string

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • bit (Fixnum) (defaults to: nil)
    What bit value to look for - must be 1, or 0

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


140
141
142
143
144
145
146
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 140

def bitpos(key=nil,bit=nil)
  if key.class == String && bit.class == Fixnum && block_given?
    @j_del.java_method(:bitpos, [Java::java.lang.String.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(key,bit,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bitpos(#{key},#{bit})"
end

- (self) bitpos_from(key = nil, bit = nil, start = nil) { ... }

Find first bit set or clear in a string See also bitposRange() method, which takes start, and stop offset.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • bit (Fixnum) (defaults to: nil)
    What bit value to look for - must be 1, or 0
  • start (Fixnum) (defaults to: nil)
    Start offset

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


155
156
157
158
159
160
161
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 155

def bitpos_from(key=nil,bit=nil,start=nil)
  if key.class == String && bit.class == Fixnum && start.class == Fixnum && block_given?
    @j_del.java_method(:bitposFrom, [Java::java.lang.String.java_class,Java::int.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(key,bit,start,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bitpos_from(#{key},#{bit},#{start})"
end

- (self) bitpos_range(key = nil, bit = nil, start = nil, stop = nil) { ... }

Find first bit set or clear in a string Note: when both start, and stop offsets are specified, behaviour is slightly different than if only start is specified

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • bit (Fixnum) (defaults to: nil)
    What bit value to look for - must be 1, or 0
  • start (Fixnum) (defaults to: nil)
    Start offset
  • stop (Fixnum) (defaults to: nil)
    End offset - inclusive

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


172
173
174
175
176
177
178
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 172

def bitpos_range(key=nil,bit=nil,start=nil,stop=nil)
  if key.class == String && bit.class == Fixnum && start.class == Fixnum && stop.class == Fixnum && block_given?
    @j_del.java_method(:bitposRange, [Java::java.lang.String.java_class,Java::int.java_class,Java::int.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(key,bit,start,stop,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling bitpos_range(#{key},#{bit},#{start},#{stop})"
end

- (self) blpop(key = nil, seconds = nil) { ... }

Remove and get the first element in a list, or block until one is available

Parameters:

  • key (String) (defaults to: nil)
    Key string identifying a list to watch
  • seconds (Fixnum) (defaults to: nil)
    Timeout in seconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


184
185
186
187
188
189
190
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 184

def blpop(key=nil,seconds=nil)
  if key.class == String && seconds.class == Fixnum && block_given?
    @j_del.java_method(:blpop, [Java::java.lang.String.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(key,seconds,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling blpop(#{key},#{seconds})"
end

- (self) blpop_many(keys = nil, seconds = nil) { ... }

Remove and get the first element in any of the lists, or block until one is available

Parameters:

  • keys (Array<String>) (defaults to: nil)
    List of key strings identifying lists to watch
  • seconds (Fixnum) (defaults to: nil)
    Timeout in seconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

def blpop_many(keys=nil,seconds=nil)
  if keys.class == Array && seconds.class == Fixnum && block_given?
    @j_del.java_method(:blpopMany, [Java::JavaUtil::List.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(keys.map { |element| element },seconds,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling blpop_many(#{keys},#{seconds})"
end

- (self) brpop(key = nil, seconds = nil) { ... }

Remove and get the last element in a list, or block until one is available

Parameters:

  • key (String) (defaults to: nil)
    Key string identifying a list to watch
  • seconds (Fixnum) (defaults to: nil)
    Timeout in seconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


208
209
210
211
212
213
214
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 208

def brpop(key=nil,seconds=nil)
  if key.class == String && seconds.class == Fixnum && block_given?
    @j_del.java_method(:brpop, [Java::java.lang.String.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(key,seconds,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling brpop(#{key},#{seconds})"
end

- (self) brpop_many(keys = nil, seconds = nil) { ... }

Remove and get the last element in any of the lists, or block until one is available

Parameters:

  • keys (Array<String>) (defaults to: nil)
    List of key strings identifying lists to watch
  • seconds (Fixnum) (defaults to: nil)
    Timeout in seconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


220
221
222
223
224
225
226
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 220

def brpop_many(keys=nil,seconds=nil)
  if keys.class == Array && seconds.class == Fixnum && block_given?
    @j_del.java_method(:brpopMany, [Java::JavaUtil::List.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(keys.map { |element| element },seconds,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling brpop_many(#{keys},#{seconds})"
end

- (self) brpoplpush(key = nil, destkey = nil, seconds = nil) { ... }

Pop a value from a list, push it to another list and return it; or block until one is available

Parameters:

  • key (String) (defaults to: nil)
    Key string identifying the source list
  • destkey (String) (defaults to: nil)
    Key string identifying the destination list
  • seconds (Fixnum) (defaults to: nil)
    Timeout in seconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


233
234
235
236
237
238
239
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 233

def brpoplpush(key=nil,destkey=nil,seconds=nil)
  if key.class == String && destkey.class == String && seconds.class == Fixnum && block_given?
    @j_del.java_method(:brpoplpush, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(key,destkey,seconds,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling brpoplpush(#{key},#{destkey},#{seconds})"
end

- (self) client_getname { ... }

Get the current connection name

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


264
265
266
267
268
269
270
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 264

def client_getname
  if block_given?
    @j_del.java_method(:clientGetname, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling client_getname()"
end

- (self) client_kill(filter = nil) { ... }

Kill the connection of a client

Parameters:

  • filter (Hash) (defaults to: nil)
    Filter options

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


244
245
246
247
248
249
250
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 244

def client_kill(filter=nil)
  if filter.class == Hash && block_given?
    @j_del.java_method(:clientKill, [Java::IoVertxRedisOp::KillFilter.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxRedisOp::KillFilter.new(::Vertx::Util::Utils.to_json_object(filter)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling client_kill(#{filter})"
end

- (self) client_list { ... }

Get the list of client connections

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


254
255
256
257
258
259
260
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 254

def client_list
  if block_given?
    @j_del.java_method(:clientList, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling client_list()"
end

- (self) client_pause(millis = nil) { ... }

Stop processing commands from clients for some time

Parameters:

  • millis (Fixnum) (defaults to: nil)
    Pause time in milliseconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


275
276
277
278
279
280
281
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 275

def client_pause(millis=nil)
  if millis.class == Fixnum && block_given?
    @j_del.java_method(:clientPause, [Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(millis,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling client_pause(#{millis})"
end

- (self) client_reply(options = nil) { ... }

Instruct the server whether to reply to commands.

Parameters:

  • options (:ON, :OFF, :SKIP) (defaults to: nil)

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


2784
2785
2786
2787
2788
2789
2790
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2784

def client_reply(options=nil)
  if options.class == Symbol && block_given?
    @j_del.java_method(:clientReply, [Java::IoVertxRedisOp::ClientReplyOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxRedisOp::ClientReplyOptions.valueOf(options.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling client_reply(#{options})"
end

- (self) client_setname(name = nil) { ... }

Set the current connection name

Parameters:

  • name (String) (defaults to: nil)
    New name for current connection

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


286
287
288
289
290
291
292
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 286

def client_setname(name=nil)
  if name.class == String && block_given?
    @j_del.java_method(:clientSetname, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(name,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling client_setname(#{name})"
end

- (void) close { ... }

This method returns an undefined value.

Close the client - when it is fully closed the handler will be called.

Yields:

Raises:

  • (ArgumentError)


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

def close
  if block_given?
    return @j_del.java_method(:close, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
  end
  raise ArgumentError, "Invalid arguments when calling close()"
end

- (self) cluster_addslots(slots = nil) { ... }

Assign new hash slots to receiving node.

Parameters:

  • slots (Array<Fixnum>) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


297
298
299
300
301
302
303
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 297

def cluster_addslots(slots=nil)
  if slots.class == Array && block_given?
    @j_del.java_method(:clusterAddslots, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(slots.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_addslots(#{slots})"
end

- (self) cluster_count_failure_reports(nodeId = nil) { ... }

Return the number of failure reports active for a given node.

Parameters:

  • nodeId (String) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


308
309
310
311
312
313
314
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 308

def cluster_count_failure_reports(nodeId=nil)
  if nodeId.class == String && block_given?
    @j_del.java_method(:clusterCountFailureReports, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(nodeId,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_count_failure_reports(#{nodeId})"
end

- (self) cluster_countkeysinslot(slot = nil) { ... }

Return the number of local keys in the specified hash slot.

Parameters:

  • slot (Fixnum) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


319
320
321
322
323
324
325
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 319

def cluster_countkeysinslot(slot=nil)
  if slot.class == Fixnum && block_given?
    @j_del.java_method(:clusterCountkeysinslot, [Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(slot,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_countkeysinslot(#{slot})"
end

- (self) cluster_delslots(slot = nil) { ... }

Set hash slots as unbound in receiving node.

Parameters:

  • slot (Fixnum) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


330
331
332
333
334
335
336
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 330

def cluster_delslots(slot=nil)
  if slot.class == Fixnum && block_given?
    @j_del.java_method(:clusterDelslots, [Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(slot,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_delslots(#{slot})"
end

- (self) cluster_delslots_many(slots = nil) { ... }

Set hash slots as unbound in receiving node.

Parameters:

  • slots (Array<Fixnum>) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


341
342
343
344
345
346
347
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 341

def cluster_delslots_many(slots=nil)
  if slots.class == Array && block_given?
    @j_del.java_method(:clusterDelslotsMany, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(slots.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_delslots_many(#{slots})"
end

- (self) cluster_fail_over_with_options(options = nil) { ... }

Forces a slave to perform a manual failover of its master.

Parameters:

  • options (:FORCE, :TAKEOVER) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


362
363
364
365
366
367
368
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 362

def cluster_fail_over_with_options(options=nil)
  if options.class == Symbol && block_given?
    @j_del.java_method(:clusterFailOverWithOptions, [Java::IoVertxRedisOp::FailoverOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxRedisOp::FailoverOptions.valueOf(options.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_fail_over_with_options(#{options})"
end

- (self) cluster_failover { ... }

Forces a slave to perform a manual failover of its master.

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


351
352
353
354
355
356
357
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 351

def cluster_failover
  if block_given?
    @j_del.java_method(:clusterFailover, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_failover()"
end

- (self) cluster_forget(nodeId = nil) { ... }

Remove a node from the nodes table.

Parameters:

  • nodeId (String) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


373
374
375
376
377
378
379
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 373

def cluster_forget(nodeId=nil)
  if nodeId.class == String && block_given?
    @j_del.java_method(:clusterForget, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(nodeId,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_forget(#{nodeId})"
end

- (self) cluster_getkeysinslot(slot = nil, count = nil) { ... }

Return local key names in the specified hash slot.

Parameters:

  • slot (Fixnum) (defaults to: nil)
  • count (Fixnum) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


385
386
387
388
389
390
391
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 385

def cluster_getkeysinslot(slot=nil,count=nil)
  if slot.class == Fixnum && count.class == Fixnum && block_given?
    @j_del.java_method(:clusterGetkeysinslot, [Java::long.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(slot,count,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_getkeysinslot(#{slot},#{count})"
end

- (self) cluster_info { ... }

Provides info about Redis Cluster node state.

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


395
396
397
398
399
400
401
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 395

def cluster_info
  if block_given?
    @j_del.java_method(:clusterInfo, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_info()"
end

- (self) cluster_keyslot(key = nil) { ... }

Returns the hash slot of the specified key.

Parameters:

  • key (String) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


406
407
408
409
410
411
412
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 406

def cluster_keyslot(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:clusterKeyslot, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_keyslot(#{key})"
end

- (self) cluster_meet(ip = nil, port = nil) { ... }

Force a node cluster to handshake with another node.

Parameters:

  • ip (String) (defaults to: nil)
  • port (Fixnum) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


418
419
420
421
422
423
424
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 418

def cluster_meet(ip=nil,port=nil)
  if ip.class == String && port.class == Fixnum && block_given?
    @j_del.java_method(:clusterMeet, [Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(ip,port,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_meet(#{ip},#{port})"
end

- (self) cluster_nodes { ... }

Get Cluster config for the node.

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


428
429
430
431
432
433
434
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 428

def cluster_nodes
  if block_given?
    @j_del.java_method(:clusterNodes, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_nodes()"
end

- (self) cluster_replicate(nodeId = nil) { ... }

Reconfigure a node as a slave of the specified master node.

Parameters:

  • nodeId (String) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


439
440
441
442
443
444
445
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 439

def cluster_replicate(nodeId=nil)
  if nodeId.class == String && block_given?
    @j_del.java_method(:clusterReplicate, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(nodeId,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_replicate(#{nodeId})"
end

- (self) cluster_reset { ... }

Reset a Redis Cluster node.

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


449
450
451
452
453
454
455
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 449

def cluster_reset
  if block_given?
    @j_del.java_method(:clusterReset, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_reset()"
end

- (self) cluster_reset_with_options(options = nil) { ... }

Reset a Redis Cluster node.

Parameters:

  • options (:HARD, :SOFT) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


460
461
462
463
464
465
466
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 460

def cluster_reset_with_options(options=nil)
  if options.class == Symbol && block_given?
    @j_del.java_method(:clusterResetWithOptions, [Java::IoVertxRedisOp::ResetOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(Java::IoVertxRedisOp::ResetOptions.valueOf(options.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_reset_with_options(#{options})"
end

- (self) cluster_saveconfig { ... }

Forces the node to save cluster state on disk.

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


470
471
472
473
474
475
476
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 470

def cluster_saveconfig
  if block_given?
    @j_del.java_method(:clusterSaveconfig, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_saveconfig()"
end

- (self) cluster_set_config_epoch(epoch = nil) { ... }

Set the configuration epoch in a new node.

Parameters:

  • epoch (Fixnum) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


481
482
483
484
485
486
487
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 481

def cluster_set_config_epoch(epoch=nil)
  if epoch.class == Fixnum && block_given?
    @j_del.java_method(:clusterSetConfigEpoch, [Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(epoch,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_set_config_epoch(#{epoch})"
end

- (self) cluster_setslot(slot = nil, subcommand = nil) { ... }

Bind an hash slot to a specific node.

Parameters:

  • slot (Fixnum) (defaults to: nil)
  • subcommand (:IMPORTING, :MIGRATING, :STABLE, :NODE) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


493
494
495
496
497
498
499
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 493

def cluster_setslot(slot=nil,subcommand=nil)
  if slot.class == Fixnum && subcommand.class == Symbol && block_given?
    @j_del.java_method(:clusterSetslot, [Java::long.java_class,Java::IoVertxRedisOp::SlotCmd.java_class,Java::IoVertxCore::Handler.java_class]).call(slot,Java::IoVertxRedisOp::SlotCmd.valueOf(subcommand.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_setslot(#{slot},#{subcommand})"
end

- (self) cluster_setslot_with_node(slot = nil, subcommand = nil, nodeId = nil) { ... }

Bind an hash slot to a specific node.

Parameters:

  • slot (Fixnum) (defaults to: nil)
  • subcommand (:IMPORTING, :MIGRATING, :STABLE, :NODE) (defaults to: nil)
  • nodeId (String) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


506
507
508
509
510
511
512
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 506

def cluster_setslot_with_node(slot=nil,subcommand=nil,nodeId=nil)
  if slot.class == Fixnum && subcommand.class == Symbol && nodeId.class == String && block_given?
    @j_del.java_method(:clusterSetslotWithNode, [Java::long.java_class,Java::IoVertxRedisOp::SlotCmd.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(slot,Java::IoVertxRedisOp::SlotCmd.valueOf(subcommand.to_s),nodeId,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_setslot_with_node(#{slot},#{subcommand},#{nodeId})"
end

- (self) cluster_slaves(nodeId = nil) { ... }

List slave nodes of the specified master node.

Parameters:

  • nodeId (String) (defaults to: nil)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


517
518
519
520
521
522
523
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 517

def cluster_slaves(nodeId=nil)
  if nodeId.class == String && block_given?
    @j_del.java_method(:clusterSlaves, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(nodeId,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_slaves(#{nodeId})"
end

- (self) cluster_slots { ... }

Get array of Cluster slot to node mappings

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


527
528
529
530
531
532
533
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 527

def cluster_slots
  if block_given?
    @j_del.java_method(:clusterSlots, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling cluster_slots()"
end

- (self) command { ... }

Get array of Redis command details

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


537
538
539
540
541
542
543
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 537

def command
  if block_given?
    @j_del.java_method(:command, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling command()"
end

- (self) command_count { ... }

Get total number of Redis commands

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

def command_count
  if block_given?
    @j_del.java_method(:commandCount, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling command_count()"
end

- (self) command_getkeys { ... }

Extract keys given a full Redis command

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


557
558
559
560
561
562
563
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 557

def command_getkeys
  if block_given?
    @j_del.java_method(:commandGetkeys, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling command_getkeys()"
end

- (self) command_info(commands = nil) { ... }

Get array of specific Redis command details

Parameters:

  • commands (Array<String>) (defaults to: nil)
    List of commands to get info for

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


568
569
570
571
572
573
574
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 568

def command_info(commands=nil)
  if commands.class == Array && block_given?
    @j_del.java_method(:commandInfo, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(commands.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling command_info(#{commands})"
end

- (self) config_get(parameter = nil) { ... }

Get the value of a configuration parameter

Parameters:

  • parameter (String) (defaults to: nil)
    Configuration parameter

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


579
580
581
582
583
584
585
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 579

def config_get(parameter=nil)
  if parameter.class == String && block_given?
    @j_del.java_method(:configGet, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(parameter,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling config_get(#{parameter})"
end

- (self) config_resetstat { ... }

Reset the stats returned by INFO

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


611
612
613
614
615
616
617
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 611

def config_resetstat
  if block_given?
    @j_del.java_method(:configResetstat, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling config_resetstat()"
end

- (self) config_rewrite { ... }

Rewrite the configuration file with the in memory configuration

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


589
590
591
592
593
594
595
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 589

def config_rewrite
  if block_given?
    @j_del.java_method(:configRewrite, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling config_rewrite()"
end

- (self) config_set(parameter = nil, value = nil) { ... }

Set a configuration parameter to the given value

Parameters:

  • parameter (String) (defaults to: nil)
    Configuration parameter
  • value (String) (defaults to: nil)
    New value

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


601
602
603
604
605
606
607
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 601

def config_set(parameter=nil,value=nil)
  if parameter.class == String && value.class == String && block_given?
    @j_del.java_method(:configSet, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(parameter,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling config_set(#{parameter},#{value})"
end

- (self) dbsize { ... }

Return the number of keys in the selected database

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


621
622
623
624
625
626
627
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 621

def dbsize
  if block_given?
    @j_del.java_method(:dbsize, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling dbsize()"
end

- (self) debug_object(key = nil) { ... }

Get debugging information about a key

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


632
633
634
635
636
637
638
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 632

def debug_object(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:debugObject, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling debug_object(#{key})"
end

- (self) debug_segfault { ... }

Make the server crash

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


642
643
644
645
646
647
648
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 642

def debug_segfault
  if block_given?
    @j_del.java_method(:debugSegfault, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling debug_segfault()"
end

- (self) decr(key = nil) { ... }

Decrement the integer value of a key by one

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


653
654
655
656
657
658
659
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 653

def decr(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:decr, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling decr(#{key})"
end

- (self) decrby(key = nil, decrement = nil) { ... }

Decrement the integer value of a key by the given number

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • decrement (Fixnum) (defaults to: nil)
    Value by which to decrement

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


665
666
667
668
669
670
671
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 665

def decrby(key=nil,decrement=nil)
  if key.class == String && decrement.class == Fixnum && block_given?
    @j_del.java_method(:decrby, [Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,decrement,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling decrby(#{key},#{decrement})"
end

- (self) del(key = nil) { ... }

Delete a key

Parameters:

  • key (String) (defaults to: nil)
    Keys to delete

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


676
677
678
679
680
681
682
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 676

def del(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:del, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling del(#{key})"
end

- (self) del_many(keys = nil) { ... }

Delete many keys

Parameters:

  • keys (Array<String>) (defaults to: nil)
    List of keys to delete

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


687
688
689
690
691
692
693
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 687

def del_many(keys=nil)
  if keys.class == Array && block_given?
    @j_del.java_method(:delMany, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(keys.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling del_many(#{keys})"
end

- (self) dump(key = nil) { ... }

Return a serialized version of the value stored at the specified key.

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


698
699
700
701
702
703
704
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 698

def dump(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:dump, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling dump(#{key})"
end

- (self) echo(message = nil) { ... }

Echo the given string

Parameters:

  • message (String) (defaults to: nil)
    String to echo

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


709
710
711
712
713
714
715
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 709

def echo(message=nil)
  if message.class == String && block_given?
    @j_del.java_method(:echo, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(message,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling echo(#{message})"
end

- (self) eval(script = nil, keys = nil, args = nil) { ... }

Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned for This reason and to ensure type safety the reply is always guaranteed to be a JsonArray. When a reply if for example a String the handler will be called with a JsonArray with a single element containing the String.

Parameters:

  • script (String) (defaults to: nil)
    Lua script to evaluate
  • keys (Array<String>) (defaults to: nil)
    List of keys
  • args (Array<String>) (defaults to: nil)
    List of argument values

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


726
727
728
729
730
731
732
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 726

def eval(script=nil,keys=nil,args=nil)
  if script.class == String && keys.class == Array && args.class == Array && block_given?
    @j_del.java_method(:eval, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(script,keys.map { |element| element },args.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling eval(#{script},#{keys},#{args})"
end

- (self) eval_script(script = nil, keys = nil, args = nil) { ... }

Execute a Lua script server side. This method is a high level wrapper around EVAL and EVALSHA using the latter if possible, falling back to EVAL if the script is not cached by the server yet. According to Redis documentation, executed scripts are guaranteed to be in the script cache of a given execution of a Redis instance forever, which means typically the overhead incurred by optimistically sending EVALSHA is minimal, while improving performance and saving bandwidth compared to using EVAL every time.

Parameters:

  • script (::VertxRedis::Script) (defaults to: nil)
    Lua script and its SHA1 digest
  • keys (Array<String>) (defaults to: nil)
    List of keys
  • args (Array<String>) (defaults to: nil)
    List of argument values

Yields:

  • Handler for the result of this call. group: scripting

Returns:

  • (self)

Raises:

  • (ArgumentError)


761
762
763
764
765
766
767
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 761

def eval_script(script=nil,keys=nil,args=nil)
  if script.class.method_defined?(:j_del) && keys.class == Array && args.class == Array && block_given?
    @j_del.java_method(:evalScript, [Java::IoVertxRedis::Script.java_class,Java::JavaUtil::List.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(script.j_del,keys.map { |element| element },args.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling eval_script(#{script},#{keys},#{args})"
end

- (self) evalsha(sha1 = nil, keys = nil, values = nil) { ... }

Execute a Lua script server side. Due to the dynamic nature of this command any response type could be returned for This reason and to ensure type safety the reply is always guaranteed to be a JsonArray. When a reply if for example a String the handler will be called with a JsonArray with a single element containing the String.

Parameters:

  • sha1 (String) (defaults to: nil)
    SHA1 digest of the script cached on the server
  • keys (Array<String>) (defaults to: nil)
    List of keys
  • values (Array<String>) (defaults to: nil)
    List of values

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


743
744
745
746
747
748
749
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 743

def evalsha(sha1=nil,keys=nil,values=nil)
  if sha1.class == String && keys.class == Array && values.class == Array && block_given?
    @j_del.java_method(:evalsha, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(sha1,keys.map { |element| element },values.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling evalsha(#{sha1},#{keys},#{values})"
end

- (self) exists(key = nil) { ... }

Determine if a key exists

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


772
773
774
775
776
777
778
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 772

def exists(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:exists, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling exists(#{key})"
end

- (self) expire(key = nil, seconds = nil) { ... }

Set a key's time to live in seconds

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • seconds (Fixnum) (defaults to: nil)
    Time to live in seconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


784
785
786
787
788
789
790
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 784

def expire(key=nil,seconds=nil)
  if key.class == String && seconds.class == Fixnum && block_given?
    @j_del.java_method(:expire, [Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,seconds,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling expire(#{key},#{seconds})"
end

- (self) expireat(key = nil, seconds = nil) { ... }

Set the expiration for a key as a UNIX timestamp

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • seconds (Fixnum) (defaults to: nil)
    Expiry time as Unix timestamp in seconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


796
797
798
799
800
801
802
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 796

def expireat(key=nil,seconds=nil)
  if key.class == String && seconds.class == Fixnum && block_given?
    @j_del.java_method(:expireat, [Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,seconds,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling expireat(#{key},#{seconds})"
end

- (self) flushall { ... }

Remove all keys from all databases

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


806
807
808
809
810
811
812
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 806

def flushall
  if block_given?
    @j_del.java_method(:flushall, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling flushall()"
end

- (self) flushdb { ... }

Remove all keys from the current database

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


816
817
818
819
820
821
822
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 816

def flushdb
  if block_given?
    @j_del.java_method(:flushdb, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling flushdb()"
end

- (self) geoadd(key = nil, longitude = nil, latitude = nil, member = nil) { ... }

Add one or more geospatial items in the geospatial index represented using a sorted set.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • longitude (Float) (defaults to: nil)
    longitude
  • latitude (Float) (defaults to: nil)
    latitude
  • member (String) (defaults to: nil)
    member

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2616
2617
2618
2619
2620
2621
2622
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2616

def geoadd(key=nil,longitude=nil,latitude=nil,member=nil)
  if key.class == String && longitude.class == Float && latitude.class == Float && member.class == String && block_given?
    @j_del.java_method(:geoadd, [Java::java.lang.String.java_class,Java::double.java_class,Java::double.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,::Vertx::Util::Utils.to_double(longitude),::Vertx::Util::Utils.to_double(latitude),member,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling geoadd(#{key},#{longitude},#{latitude},#{member})"
end

- (self) geoadd_many(key = nil, members = nil) { ... }

Add one or more geospatial items in the geospatial index represented using a sorted set.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • members (Array<Hash>) (defaults to: nil)
    list of <lon, lat, member>

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2628
2629
2630
2631
2632
2633
2634
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2628

def geoadd_many(key=nil,members=nil)
  if key.class == String && members.class == Array && block_given?
    @j_del.java_method(:geoaddMany, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(key,members.map { |element| Java::IoVertxRedisOp::GeoMember.new(::Vertx::Util::Utils.to_json_object(element)) },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling geoadd_many(#{key},#{members})"
end

- (self) geodist(key = nil, member1 = nil, member2 = nil) { ... }

Return the distance between two members in the geospatial index represented by the sorted set.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • member1 (String) (defaults to: nil)
    member 1
  • member2 (String) (defaults to: nil)
    member 2

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2693
2694
2695
2696
2697
2698
2699
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2693

def geodist(key=nil,member1=nil,member2=nil)
  if key.class == String && member1.class == String && member2.class == String && block_given?
    @j_del.java_method(:geodist, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,member1,member2,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling geodist(#{key},#{member1},#{member2})"
end

- (self) geodist_with_unit(key = nil, member1 = nil, member2 = nil, unit = nil) { ... }

Return the distance between two members in the geospatial index represented by the sorted set.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • member1 (String) (defaults to: nil)
    member 1
  • member2 (String) (defaults to: nil)
    member 2
  • unit (:m, :km, :mi, :ft) (defaults to: nil)
    geo unit

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2707
2708
2709
2710
2711
2712
2713
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2707

def geodist_with_unit(key=nil,member1=nil,member2=nil,unit=nil)
  if key.class == String && member1.class == String && member2.class == String && unit.class == Symbol && block_given?
    @j_del.java_method(:geodistWithUnit, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxRedisOp::GeoUnit.java_class,Java::IoVertxCore::Handler.java_class]).call(key,member1,member2,Java::IoVertxRedisOp::GeoUnit.valueOf(unit.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling geodist_with_unit(#{key},#{member1},#{member2},#{unit})"
end

- (self) geohash(key = nil, member = nil) { ... }

Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • member (String) (defaults to: nil)
    member

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2641
2642
2643
2644
2645
2646
2647
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2641

def geohash(key=nil,member=nil)
  if key.class == String && member.class == String && block_given?
    @j_del.java_method(:geohash, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,member,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling geohash(#{key},#{member})"
end

- (self) geohash_many(key = nil, members = nil) { ... }

Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • members (Array<String>) (defaults to: nil)
    list of members

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2654
2655
2656
2657
2658
2659
2660
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2654

def geohash_many(key=nil,members=nil)
  if key.class == String && members.class == Array && block_given?
    @j_del.java_method(:geohashMany, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(key,members.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling geohash_many(#{key},#{members})"
end

- (self) geopos(key = nil, member = nil) { ... }

Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • member (String) (defaults to: nil)
    member

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2667
2668
2669
2670
2671
2672
2673
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2667

def geopos(key=nil,member=nil)
  if key.class == String && member.class == String && block_given?
    @j_del.java_method(:geopos, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,member,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling geopos(#{key},#{member})"
end

- (self) geopos_many(key = nil, members = nil) { ... }

Return the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • members (Array<String>) (defaults to: nil)
    list of members

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2680
2681
2682
2683
2684
2685
2686
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2680

def geopos_many(key=nil,members=nil)
  if key.class == String && members.class == Array && block_given?
    @j_del.java_method(:geoposMany, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(key,members.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling geopos_many(#{key},#{members})"
end

- (self) georadius(key = nil, longitude = nil, latitude = nil, radius = nil, unit = nil) { ... }

Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • longitude (Float) (defaults to: nil)
    longitude
  • latitude (Float) (defaults to: nil)
    latitude
  • radius (Float) (defaults to: nil)
    radius
  • unit (:m, :km, :mi, :ft) (defaults to: nil)
    geo unit

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2723
2724
2725
2726
2727
2728
2729
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2723

def georadius(key=nil,longitude=nil,latitude=nil,radius=nil,unit=nil)
  if key.class == String && longitude.class == Float && latitude.class == Float && radius.class == Float && unit.class == Symbol && block_given?
    @j_del.java_method(:georadius, [Java::java.lang.String.java_class,Java::double.java_class,Java::double.java_class,Java::double.java_class,Java::IoVertxRedisOp::GeoUnit.java_class,Java::IoVertxCore::Handler.java_class]).call(key,::Vertx::Util::Utils.to_double(longitude),::Vertx::Util::Utils.to_double(latitude),::Vertx::Util::Utils.to_double(radius),Java::IoVertxRedisOp::GeoUnit.valueOf(unit.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling georadius(#{key},#{longitude},#{latitude},#{radius},#{unit})"
end

- (self) georadius_with_options(key = nil, longitude = nil, latitude = nil, radius = nil, unit = nil, options = nil) { ... }

Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • longitude (Float) (defaults to: nil)
    longitude
  • latitude (Float) (defaults to: nil)
    latitude
  • radius (Float) (defaults to: nil)
    radius
  • unit (:m, :km, :mi, :ft) (defaults to: nil)
    geo unit
  • options (Hash) (defaults to: nil)
    geo radius options

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2740
2741
2742
2743
2744
2745
2746
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2740

def georadius_with_options(key=nil,longitude=nil,latitude=nil,radius=nil,unit=nil,options=nil)
  if key.class == String && longitude.class == Float && latitude.class == Float && radius.class == Float && unit.class == Symbol && options.class == Hash && block_given?
    @j_del.java_method(:georadiusWithOptions, [Java::java.lang.String.java_class,Java::double.java_class,Java::double.java_class,Java::double.java_class,Java::IoVertxRedisOp::GeoUnit.java_class,Java::IoVertxRedisOp::GeoRadiusOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(key,::Vertx::Util::Utils.to_double(longitude),::Vertx::Util::Utils.to_double(latitude),::Vertx::Util::Utils.to_double(radius),Java::IoVertxRedisOp::GeoUnit.valueOf(unit.to_s),Java::IoVertxRedisOp::GeoRadiusOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling georadius_with_options(#{key},#{longitude},#{latitude},#{radius},#{unit},#{options})"
end

- (self) georadiusbymember(key = nil, member = nil, radius = nil, unit = nil) { ... }

This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • member (String) (defaults to: nil)
    member
  • radius (Float) (defaults to: nil)
    radius
  • unit (:m, :km, :mi, :ft) (defaults to: nil)
    geo unit

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2756
2757
2758
2759
2760
2761
2762
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2756

def georadiusbymember(key=nil,member=nil,radius=nil,unit=nil)
  if key.class == String && member.class == String && radius.class == Float && unit.class == Symbol && block_given?
    @j_del.java_method(:georadiusbymember, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::double.java_class,Java::IoVertxRedisOp::GeoUnit.java_class,Java::IoVertxCore::Handler.java_class]).call(key,member,::Vertx::Util::Utils.to_double(radius),Java::IoVertxRedisOp::GeoUnit.valueOf(unit.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling georadiusbymember(#{key},#{member},#{radius},#{unit})"
end

- (self) georadiusbymember_with_options(key = nil, member = nil, radius = nil, unit = nil, options = nil) { ... }

This command is exactly like GEORADIUS with the sole difference that instead of taking, as the center of the area to query, a longitude and latitude value, it takes the name of a member already existing inside the geospatial index represented by the sorted set.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • member (String) (defaults to: nil)
    member
  • radius (Float) (defaults to: nil)
    radius
  • unit (:m, :km, :mi, :ft) (defaults to: nil)
    geo unit
  • options (Hash) (defaults to: nil)
    geo radius options

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2773
2774
2775
2776
2777
2778
2779
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2773

def georadiusbymember_with_options(key=nil,member=nil,radius=nil,unit=nil,options=nil)
  if key.class == String && member.class == String && radius.class == Float && unit.class == Symbol && options.class == Hash && block_given?
    @j_del.java_method(:georadiusbymemberWithOptions, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::double.java_class,Java::IoVertxRedisOp::GeoUnit.java_class,Java::IoVertxRedisOp::GeoRadiusOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(key,member,::Vertx::Util::Utils.to_double(radius),Java::IoVertxRedisOp::GeoUnit.valueOf(unit.to_s),Java::IoVertxRedisOp::GeoRadiusOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling georadiusbymember_with_options(#{key},#{member},#{radius},#{unit},#{options})"
end

- (self) get(key = nil) { ... }

Get the value of a key

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

def get(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:get, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling get(#{key})"
end

- (self) get_binary(key = nil) { ... }

Get the value of a key - without decoding as utf-8

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


838
839
840
841
842
843
844
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 838

def get_binary(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:getBinary, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::Vertx::Buffer) : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling get_binary(#{key})"
end

- (self) getbit(key = nil, offset = nil) { ... }

Returns the bit value at offset in the string value stored at key

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • offset (Fixnum) (defaults to: nil)
    Offset in bits

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


850
851
852
853
854
855
856
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 850

def getbit(key=nil,offset=nil)
  if key.class == String && offset.class == Fixnum && block_given?
    @j_del.java_method(:getbit, [Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,offset,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling getbit(#{key},#{offset})"
end

- (self) getrange(key = nil, start = nil, _end = nil) { ... }

Get a substring of the string stored at a key

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • start (Fixnum) (defaults to: nil)
    Start offset
  • _end (Fixnum) (defaults to: nil)
    End offset - inclusive

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


863
864
865
866
867
868
869
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 863

def getrange(key=nil,start=nil,_end=nil)
  if key.class == String && start.class == Fixnum && _end.class == Fixnum && block_given?
    @j_del.java_method(:getrange, [Java::java.lang.String.java_class,Java::long.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,start,_end,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling getrange(#{key},#{start},#{_end})"
end

- (self) getset(key = nil, value = nil) { ... }

Set the string value of a key and return its old value

Parameters:

  • key (String) (defaults to: nil)
    Key of which value to set
  • value (String) (defaults to: nil)
    New value for the key

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


875
876
877
878
879
880
881
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 875

def getset(key=nil,value=nil)
  if key.class == String && value.class == String && block_given?
    @j_del.java_method(:getset, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling getset(#{key},#{value})"
end

- (self) hdel(key = nil, field = nil) { ... }

Delete one or more hash fields

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • field (String) (defaults to: nil)
    Field name

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


887
888
889
890
891
892
893
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 887

def hdel(key=nil,field=nil)
  if key.class == String && field.class == String && block_given?
    @j_del.java_method(:hdel, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,field,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hdel(#{key},#{field})"
end

- (self) hdel_many(key = nil, fields = nil) { ... }

Delete one or more hash fields

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • fields (Array<String>) (defaults to: nil)
    Field names

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


899
900
901
902
903
904
905
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 899

def hdel_many(key=nil,fields=nil)
  if key.class == String && fields.class == Array && block_given?
    @j_del.java_method(:hdelMany, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(key,fields.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hdel_many(#{key},#{fields})"
end

- (self) hexists(key = nil, field = nil) { ... }

Determine if a hash field exists

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • field (String) (defaults to: nil)
    Field name

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

def hexists(key=nil,field=nil)
  if key.class == String && field.class == String && block_given?
    @j_del.java_method(:hexists, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,field,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hexists(#{key},#{field})"
end

- (self) hget(key = nil, field = nil) { ... }

Get the value of a hash field

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • field (String) (defaults to: nil)
    Field name

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


923
924
925
926
927
928
929
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 923

def hget(key=nil,field=nil)
  if key.class == String && field.class == String && block_given?
    @j_del.java_method(:hget, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,field,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hget(#{key},#{field})"
end

- (self) hgetall(key = nil) { ... }

Get all the fields and values in a hash

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


934
935
936
937
938
939
940
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 934

def hgetall(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:hgetall, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hgetall(#{key})"
end

- (self) hincrby(key = nil, field = nil, increment = nil) { ... }

Increment the integer value of a hash field by the given number

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • field (String) (defaults to: nil)
    Field name
  • increment (Fixnum) (defaults to: nil)
    Value by which to increment

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


947
948
949
950
951
952
953
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 947

def hincrby(key=nil,field=nil,increment=nil)
  if key.class == String && field.class == String && increment.class == Fixnum && block_given?
    @j_del.java_method(:hincrby, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,field,increment,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hincrby(#{key},#{field},#{increment})"
end

- (self) hincrbyfloat(key = nil, field = nil, increment = nil) { ... }

Increment the float value of a hash field by the given amount

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • field (String) (defaults to: nil)
    Field name
  • increment (Float) (defaults to: nil)
    Value by which to increment

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


960
961
962
963
964
965
966
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 960

def hincrbyfloat(key=nil,field=nil,increment=nil)
  if key.class == String && field.class == String && increment.class == Float && block_given?
    @j_del.java_method(:hincrbyfloat, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::double.java_class,Java::IoVertxCore::Handler.java_class]).call(key,field,::Vertx::Util::Utils.to_double(increment),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hincrbyfloat(#{key},#{field},#{increment})"
end

- (self) hkeys(key = nil) { ... }

Get all the fields in a hash

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


971
972
973
974
975
976
977
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 971

def hkeys(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:hkeys, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hkeys(#{key})"
end

- (self) hlen(key = nil) { ... }

Get the number of fields in a hash

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


982
983
984
985
986
987
988
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 982

def hlen(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:hlen, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hlen(#{key})"
end

- (self) hmget(key = nil, fields = nil) { ... }

Get the values of all the given hash fields

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • fields (Array<String>) (defaults to: nil)
    Field names

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


994
995
996
997
998
999
1000
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 994

def hmget(key=nil,fields=nil)
  if key.class == String && fields.class == Array && block_given?
    @j_del.java_method(:hmget, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(key,fields.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hmget(#{key},#{fields})"
end

- (self) hmset(key = nil, values = nil) { ... }

Set multiple hash fields to multiple values

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • values (Hash{String => Object}) (defaults to: nil)
    Map of field:value pairs

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1006
1007
1008
1009
1010
1011
1012
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1006

def hmset(key=nil,values=nil)
  if key.class == String && values.class == Hash && block_given?
    @j_del.java_method(:hmset, [Java::java.lang.String.java_class,Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(key,::Vertx::Util::Utils.to_json_object(values),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hmset(#{key},#{values})"
end

- (self) hscan(key = nil, cursor = nil, options = nil) { ... }

Incrementally iterate hash fields and associated values

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • cursor (String) (defaults to: nil)
    Cursor id
  • options (Hash) (defaults to: nil)
    Scan options

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


2589
2590
2591
2592
2593
2594
2595
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2589

def hscan(key=nil,cursor=nil,options=nil)
  if key.class == String && cursor.class == String && options.class == Hash && block_given?
    @j_del.java_method(:hscan, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxRedisOp::ScanOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(key,cursor,Java::IoVertxRedisOp::ScanOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hscan(#{key},#{cursor},#{options})"
end

- (self) hset(key = nil, field = nil, value = nil) { ... }

Set the string value of a hash field

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • field (String) (defaults to: nil)
    Field name
  • value (String) (defaults to: nil)
    New value

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1019
1020
1021
1022
1023
1024
1025
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1019

def hset(key=nil,field=nil,value=nil)
  if key.class == String && field.class == String && value.class == String && block_given?
    @j_del.java_method(:hset, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,field,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hset(#{key},#{field},#{value})"
end

- (self) hsetnx(key = nil, field = nil, value = nil) { ... }

Set the value of a hash field, only if the field does not exist

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • field (String) (defaults to: nil)
    Field name
  • value (String) (defaults to: nil)
    New value

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

def hsetnx(key=nil,field=nil,value=nil)
  if key.class == String && field.class == String && value.class == String && block_given?
    @j_del.java_method(:hsetnx, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,field,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hsetnx(#{key},#{field},#{value})"
end

- (self) hstrlen(key = nil, field = nil) { ... }

Get the length of the value of a hash field.

Parameters:

  • key (String) (defaults to: nil)
    Key String
  • field (String) (defaults to: nil)
    field

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


2796
2797
2798
2799
2800
2801
2802
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2796

def hstrlen(key=nil,field=nil)
  if key.class == String && field.class == String && block_given?
    @j_del.java_method(:hstrlen, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,field,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hstrlen(#{key},#{field})"
end

- (self) hvals(key = nil) { ... }

Get all the values in a hash

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1043
1044
1045
1046
1047
1048
1049
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1043

def hvals(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:hvals, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling hvals(#{key})"
end

- (self) incr(key = nil) { ... }

Increment the integer value of a key by one

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1054
1055
1056
1057
1058
1059
1060
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1054

def incr(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:incr, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling incr(#{key})"
end

- (self) incrby(key = nil, increment = nil) { ... }

Increment the integer value of a key by the given amount

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • increment (Fixnum) (defaults to: nil)
    Value by which to increment

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1066
1067
1068
1069
1070
1071
1072
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1066

def incrby(key=nil,increment=nil)
  if key.class == String && increment.class == Fixnum && block_given?
    @j_del.java_method(:incrby, [Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,increment,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling incrby(#{key},#{increment})"
end

- (self) incrbyfloat(key = nil, increment = nil) { ... }

Increment the float value of a key by the given amount

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • increment (Float) (defaults to: nil)
    Value by which to increment

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1078
1079
1080
1081
1082
1083
1084
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1078

def incrbyfloat(key=nil,increment=nil)
  if key.class == String && increment.class == Float && block_given?
    @j_del.java_method(:incrbyfloat, [Java::java.lang.String.java_class,Java::double.java_class,Java::IoVertxCore::Handler.java_class]).call(key,::Vertx::Util::Utils.to_double(increment),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling incrbyfloat(#{key},#{increment})"
end

- (self) info { ... }

Get information and statistics about the server

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1088
1089
1090
1091
1092
1093
1094
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1088

def info
  if block_given?
    @j_del.java_method(:info, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling info()"
end

- (self) info_section(section = nil) { ... }

Get information and statistics about the server

Parameters:

  • section (String) (defaults to: nil)
    Specific section of information to return

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1099
1100
1101
1102
1103
1104
1105
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1099

def info_section(section=nil)
  if section.class == String && block_given?
    @j_del.java_method(:infoSection, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(section,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling info_section(#{section})"
end

- (self) keys(pattern = nil) { ... }

Find all keys matching the given pattern

Parameters:

  • pattern (String) (defaults to: nil)
    Pattern to limit the keys returned

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1110
1111
1112
1113
1114
1115
1116
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1110

def keys(pattern=nil)
  if pattern.class == String && block_given?
    @j_del.java_method(:keys, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(pattern,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling keys(#{pattern})"
end

- (self) lastsave { ... }

Get the UNIX time stamp of the last successful save to disk

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


1120
1121
1122
1123
1124
1125
1126
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1120

def lastsave
  if block_given?
    @j_del.java_method(:lastsave, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lastsave()"
end

- (self) lindex(key = nil, index = nil) { ... }

Get an element from a list by its index

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • index (Fixnum) (defaults to: nil)
    Index of list element to get

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1132
1133
1134
1135
1136
1137
1138
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1132

def lindex(key=nil,index=nil)
  if key.class == String && index.class == Fixnum && block_given?
    @j_del.java_method(:lindex, [Java::java.lang.String.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(key,index,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lindex(#{key},#{index})"
end

- (self) linsert(key = nil, option = nil, pivot = nil, value = nil) { ... }

Insert an element before or after another element in a list

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • option (:BEFORE, :AFTER) (defaults to: nil)
    BEFORE or AFTER
  • pivot (String) (defaults to: nil)
    Key to use as a pivot
  • value (String) (defaults to: nil)
    Value to be inserted before or after the pivot

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1146
1147
1148
1149
1150
1151
1152
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1146

def linsert(key=nil,option=nil,pivot=nil,value=nil)
  if key.class == String && option.class == Symbol && pivot.class == String && value.class == String && block_given?
    @j_del.java_method(:linsert, [Java::java.lang.String.java_class,Java::IoVertxRedisOp::InsertOptions.java_class,Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,Java::IoVertxRedisOp::InsertOptions.valueOf(option.to_s),pivot,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling linsert(#{key},#{option},#{pivot},#{value})"
end

- (self) llen(key = nil) { ... }

Get the length of a list

Parameters:

  • key (String) (defaults to: nil)
    String key

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1157
1158
1159
1160
1161
1162
1163
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1157

def llen(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:llen, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling llen(#{key})"
end

- (self) lpop(key = nil) { ... }

Remove and get the first element in a list

Parameters:

  • key (String) (defaults to: nil)
    String key

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1168
1169
1170
1171
1172
1173
1174
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1168

def lpop(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:lpop, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lpop(#{key})"
end

- (self) lpush(key = nil, value = nil) { ... }

Prepend one value to a list

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • value (String) (defaults to: nil)
    Value to be added at the beginning of the list

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1192
1193
1194
1195
1196
1197
1198
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1192

def lpush(key=nil,value=nil)
  if key.class == String && value.class == String && block_given?
    @j_del.java_method(:lpush, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lpush(#{key},#{value})"
end

- (self) lpush_many(key = nil, values = nil) { ... }

Prepend one or multiple values to a list

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • values (Array<String>) (defaults to: nil)
    Values to be added at the beginning of the list, one by one

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1180
1181
1182
1183
1184
1185
1186
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1180

def lpush_many(key=nil,values=nil)
  if key.class == String && values.class == Array && block_given?
    @j_del.java_method(:lpushMany, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(key,values.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lpush_many(#{key},#{values})"
end

- (self) lpushx(key = nil, value = nil) { ... }

Prepend a value to a list, only if the list exists

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • value (String) (defaults to: nil)
    Value to add at the beginning of the list

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1204
1205
1206
1207
1208
1209
1210
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1204

def lpushx(key=nil,value=nil)
  if key.class == String && value.class == String && block_given?
    @j_del.java_method(:lpushx, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lpushx(#{key},#{value})"
end

- (self) lrange(key = nil, from = nil, to = nil) { ... }

Get a range of elements from a list

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • from (Fixnum) (defaults to: nil)
    Start index
  • to (Fixnum) (defaults to: nil)
    Stop index

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1217
1218
1219
1220
1221
1222
1223
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1217

def lrange(key=nil,from=nil,to=nil)
  if key.class == String && from.class == Fixnum && to.class == Fixnum && block_given?
    @j_del.java_method(:lrange, [Java::java.lang.String.java_class,Java::long.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,from,to,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lrange(#{key},#{from},#{to})"
end

- (self) lrem(key = nil, count = nil, value = nil) { ... }

Remove elements from a list

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • count (Fixnum) (defaults to: nil)
    Number of first found occurrences equal to $value to remove from the list
  • value (String) (defaults to: nil)
    Value to be removed

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1230
1231
1232
1233
1234
1235
1236
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1230

def lrem(key=nil,count=nil,value=nil)
  if key.class == String && count.class == Fixnum && value.class == String && block_given?
    @j_del.java_method(:lrem, [Java::java.lang.String.java_class,Java::long.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,count,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lrem(#{key},#{count},#{value})"
end

- (self) lset(key = nil, index = nil, value = nil) { ... }

Set the value of an element in a list by its index

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • index (Fixnum) (defaults to: nil)
    Position within list
  • value (String) (defaults to: nil)
    New value

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1243
1244
1245
1246
1247
1248
1249
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1243

def lset(key=nil,index=nil,value=nil)
  if key.class == String && index.class == Fixnum && value.class == String && block_given?
    @j_del.java_method(:lset, [Java::java.lang.String.java_class,Java::long.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,index,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling lset(#{key},#{index},#{value})"
end

- (self) ltrim(key = nil, from = nil, to = nil) { ... }

Trim a list to the specified range

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • from (Fixnum) (defaults to: nil)
    Start index
  • to (Fixnum) (defaults to: nil)
    Stop index

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1256
1257
1258
1259
1260
1261
1262
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1256

def ltrim(key=nil,from=nil,to=nil)
  if key.class == String && from.class == Fixnum && to.class == Fixnum && block_given?
    @j_del.java_method(:ltrim, [Java::java.lang.String.java_class,Java::long.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,from,to,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling ltrim(#{key},#{from},#{to})"
end

- (self) mget(key = nil) { ... }

Get the value of the given key

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1267
1268
1269
1270
1271
1272
1273
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1267

def mget(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:mget, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling mget(#{key})"
end

- (self) mget_many(keys = nil) { ... }

Get the values of all the given keys

Parameters:

  • keys (Array<String>) (defaults to: nil)
    List of keys to get

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1278
1279
1280
1281
1282
1283
1284
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1278

def mget_many(keys=nil)
  if keys.class == Array && block_given?
    @j_del.java_method(:mgetMany, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(keys.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling mget_many(#{keys})"
end

- (self) migrate(host = nil, port = nil, key = nil, destdb = nil, timeout = nil, options = nil) { ... }

Atomically transfer a key from a Redis instance to another one.

Parameters:

  • host (String) (defaults to: nil)
    Destination host
  • port (Fixnum) (defaults to: nil)
    Destination port
  • key (String) (defaults to: nil)
    Key to migrate
  • destdb (Fixnum) (defaults to: nil)
    Destination database index
  • timeout (Fixnum) (defaults to: nil)
  • options (Hash) (defaults to: nil)
    Migrate options

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1294
1295
1296
1297
1298
1299
1300
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1294

def migrate(host=nil,port=nil,key=nil,destdb=nil,timeout=nil,options=nil)
  if host.class == String && port.class == Fixnum && key.class == String && destdb.class == Fixnum && timeout.class == Fixnum && options.class == Hash && block_given?
    @j_del.java_method(:migrate, [Java::java.lang.String.java_class,Java::int.java_class,Java::java.lang.String.java_class,Java::int.java_class,Java::long.java_class,Java::IoVertxRedisOp::MigrateOptions.java_class,Java::IoVertxCore::Handler.java_class]).call(host,port,key,destdb,timeout,Java::IoVertxRedisOp::MigrateOptions.new(::Vertx::Util::Utils.to_json_object(options)),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling migrate(#{host},#{port},#{key},#{destdb},#{timeout},#{options})"
end

- (self) monitor { ... }

Listen for all requests received by the server in real time

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


1304
1305
1306
1307
1308
1309
1310
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1304

def monitor
  if block_given?
    @j_del.java_method(:monitor, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling monitor()"
end

- (self) move(key = nil, destdb = nil) { ... }

Move a key to another database

Parameters:

  • key (String) (defaults to: nil)
    Key to migrate
  • destdb (Fixnum) (defaults to: nil)
    Destination database index

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1316
1317
1318
1319
1320
1321
1322
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1316

def move(key=nil,destdb=nil)
  if key.class == String && destdb.class == Fixnum && block_given?
    @j_del.java_method(:move, [Java::java.lang.String.java_class,Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(key,destdb,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling move(#{key},#{destdb})"
end

- (self) mset(keyvals = nil) { ... }

Set multiple keys to multiple values

Parameters:

  • keyvals (Hash{String => Object}) (defaults to: nil)
    Key value pairs to set

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1327
1328
1329
1330
1331
1332
1333
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1327

def mset(keyvals=nil)
  if keyvals.class == Hash && block_given?
    @j_del.java_method(:mset, [Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(::Vertx::Util::Utils.to_json_object(keyvals),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling mset(#{keyvals})"
end

- (self) msetnx(keyvals = nil) { ... }

Set multiple keys to multiple values, only if none of the keys exist

Parameters:

  • keyvals (Hash{String => Object}) (defaults to: nil)
    Key value pairs to set

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1338
1339
1340
1341
1342
1343
1344
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1338

def msetnx(keyvals=nil)
  if keyvals.class == Hash && block_given?
    @j_del.java_method(:msetnx, [Java::IoVertxCoreJson::JsonObject.java_class,Java::IoVertxCore::Handler.java_class]).call(::Vertx::Util::Utils.to_json_object(keyvals),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling msetnx(#{keyvals})"
end

- (self) object(key = nil, cmd = nil) { ... }

Inspect the internals of Redis objects

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • cmd (:REFCOUNT, :ENCODING, :IDLETIME) (defaults to: nil)
    Object sub command

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1350
1351
1352
1353
1354
1355
1356
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1350

def object(key=nil,cmd=nil)
  if key.class == String && cmd.class == Symbol && block_given?
    @j_del.java_method(:object, [Java::java.lang.String.java_class,Java::IoVertxRedisOp::ObjectCmd.java_class,Java::IoVertxCore::Handler.java_class]).call(key,Java::IoVertxRedisOp::ObjectCmd.valueOf(cmd.to_s),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling object(#{key},#{cmd})"
end

- (self) persist(key = nil) { ... }

Remove the expiration from a key

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1361
1362
1363
1364
1365
1366
1367
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1361

def persist(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:persist, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling persist(#{key})"
end

- (self) pexpire(key = nil, millis = nil) { ... }

Set a key's time to live in milliseconds

Parameters:

  • key (String) (defaults to: nil)
    String key
  • millis (Fixnum) (defaults to: nil)
    Time to live in milliseconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1373
1374
1375
1376
1377
1378
1379
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1373

def pexpire(key=nil,millis=nil)
  if key.class == String && millis.class == Fixnum && block_given?
    @j_del.java_method(:pexpire, [Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,millis,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pexpire(#{key},#{millis})"
end

- (self) pexpireat(key = nil, millis = nil) { ... }

Set the expiration for a key as a UNIX timestamp specified in milliseconds

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • millis (Fixnum) (defaults to: nil)
    Expiry time as Unix timestamp in milliseconds

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1385
1386
1387
1388
1389
1390
1391
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1385

def pexpireat(key=nil,millis=nil)
  if key.class == String && millis.class == Fixnum && block_given?
    @j_del.java_method(:pexpireat, [Java::java.lang.String.java_class,Java::long.java_class,Java::IoVertxCore::Handler.java_class]).call(key,millis,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pexpireat(#{key},#{millis})"
end

- (self) pfadd(key = nil, element = nil) { ... }

Adds the specified element to the specified HyperLogLog.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • element (String) (defaults to: nil)
    Element to add

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1397
1398
1399
1400
1401
1402
1403
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1397

def pfadd(key=nil,element=nil)
  if key.class == String && element.class == String && block_given?
    @j_del.java_method(:pfadd, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,element,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pfadd(#{key},#{element})"
end

- (self) pfadd_many(key = nil, elements = nil) { ... }

Adds the specified elements to the specified HyperLogLog.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • elements (Array<String>) (defaults to: nil)
    Elementa to add

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1409
1410
1411
1412
1413
1414
1415
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1409

def pfadd_many(key=nil,elements=nil)
  if key.class == String && elements.class == Array && block_given?
    @j_del.java_method(:pfaddMany, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(key,elements.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pfadd_many(#{key},#{elements})"
end

- (self) pfcount(key = nil) { ... }

Return the approximated cardinality of the set observed by the HyperLogLog at key.

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1420
1421
1422
1423
1424
1425
1426
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1420

def pfcount(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:pfcount, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pfcount(#{key})"
end

- (self) pfcount_many(keys = nil) { ... }

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).

Parameters:

  • keys (Array<String>) (defaults to: nil)
    List of keys

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1431
1432
1433
1434
1435
1436
1437
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1431

def pfcount_many(keys=nil)
  if keys.class == Array && block_given?
    @j_del.java_method(:pfcountMany, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(keys.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pfcount_many(#{keys})"
end

- (self) pfmerge(destkey = nil, keys = nil) { ... }

Merge N different HyperLogLogs into a single one.

Parameters:

  • destkey (String) (defaults to: nil)
    Destination key
  • keys (Array<String>) (defaults to: nil)
    List of source keys

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1443
1444
1445
1446
1447
1448
1449
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1443

def pfmerge(destkey=nil,keys=nil)
  if destkey.class == String && keys.class == Array && block_given?
    @j_del.java_method(:pfmerge, [Java::java.lang.String.java_class,Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(destkey,keys.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pfmerge(#{destkey},#{keys})"
end

- (self) ping { ... }

Ping the server

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


1453
1454
1455
1456
1457
1458
1459
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1453

def ping
  if block_given?
    @j_del.java_method(:ping, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling ping()"
end

- (self) psetex(key = nil, millis = nil, value = nil) { ... }

Set the value and expiration in milliseconds of a key

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • millis (Fixnum) (defaults to: nil)
    Number of milliseconds until the key expires
  • value (String) (defaults to: nil)
    New value for key

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1466
1467
1468
1469
1470
1471
1472
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1466

def psetex(key=nil,millis=nil,value=nil)
  if key.class == String && millis.class == Fixnum && value.class == String && block_given?
    @j_del.java_method(:psetex, [Java::java.lang.String.java_class,Java::long.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,millis,value,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling psetex(#{key},#{millis},#{value})"
end

- (self) psubscribe(pattern = nil) { ... }

Listen for messages published to channels matching the given pattern

Parameters:

  • pattern (String) (defaults to: nil)
    Pattern string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1477
1478
1479
1480
1481
1482
1483
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1477

def psubscribe(pattern=nil)
  if pattern.class == String && block_given?
    @j_del.java_method(:psubscribe, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(pattern,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling psubscribe(#{pattern})"
end

- (self) psubscribe_many(patterns = nil) { ... }

Listen for messages published to channels matching the given patterns

Parameters:

  • patterns (Array<String>) (defaults to: nil)
    List of patterns

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1488
1489
1490
1491
1492
1493
1494
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1488

def psubscribe_many(patterns=nil)
  if patterns.class == Array && block_given?
    @j_del.java_method(:psubscribeMany, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(patterns.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling psubscribe_many(#{patterns})"
end

- (self) pttl(key = nil) { ... }

Get the time to live for a key in milliseconds

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1531
1532
1533
1534
1535
1536
1537
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1531

def pttl(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:pttl, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pttl(#{key})"
end

- (self) publish(channel = nil, message = nil) { ... }

Post a message to a channel

Parameters:

  • channel (String) (defaults to: nil)
    Channel key
  • message (String) (defaults to: nil)
    Message to send to channel

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1543
1544
1545
1546
1547
1548
1549
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1543

def publish(channel=nil,message=nil)
  if channel.class == String && message.class == String && block_given?
    @j_del.java_method(:publish, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(channel,message,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling publish(#{channel},#{message})"
end

- (self) pubsub_channels(pattern = nil) { ... }

Lists the currently active channels - only those matching the pattern

Parameters:

  • pattern (String) (defaults to: nil)
    A glob-style pattern - an empty string means no pattern

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1499
1500
1501
1502
1503
1504
1505
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1499

def pubsub_channels(pattern=nil)
  if pattern.class == String && block_given?
    @j_del.java_method(:pubsubChannels, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(pattern,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pubsub_channels(#{pattern})"
end

- (self) pubsub_numpat { ... }

Returns the number of subscriptions to patterns (that are performed using the PSUBSCRIBE command)

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1520
1521
1522
1523
1524
1525
1526
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1520

def pubsub_numpat
  if block_given?
    @j_del.java_method(:pubsubNumpat, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pubsub_numpat()"
end

- (self) pubsub_numsub(channels = nil) { ... }

Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels

Parameters:

  • channels (Array<String>) (defaults to: nil)
    List of channels

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1510
1511
1512
1513
1514
1515
1516
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1510

def pubsub_numsub(channels=nil)
  if channels.class == Array && block_given?
    @j_del.java_method(:pubsubNumsub, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(channels.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pubsub_numsub(#{channels})"
end

- (self) punsubscribe(patterns = nil) { ... }

Stop listening for messages posted to channels matching the given patterns

Parameters:

  • patterns (Array<String>) (defaults to: nil)
    List of patterns to match against

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1554
1555
1556
1557
1558
1559
1560
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1554

def punsubscribe(patterns=nil)
  if patterns.class == Array && block_given?
    @j_del.java_method(:punsubscribe, [Java::JavaUtil::List.java_class,Java::IoVertxCore::Handler.java_class]).call(patterns.map { |element| element },(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling punsubscribe(#{patterns})"
end

- (self) randomkey { ... }

Return a random key from the keyspace

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


1564
1565
1566
1567
1568
1569
1570
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1564

def randomkey
  if block_given?
    @j_del.java_method(:randomkey, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling randomkey()"
end

- (self) rename(key = nil, newkey = nil) { ... }

Rename a key

Parameters:

  • key (String) (defaults to: nil)
    Key string to be renamed
  • newkey (String) (defaults to: nil)
    New key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1576
1577
1578
1579
1580
1581
1582
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1576

def rename(key=nil,newkey=nil)
  if key.class == String && newkey.class == String && block_given?
    @j_del.java_method(:rename, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,newkey,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling rename(#{key},#{newkey})"
end

- (self) renamenx(key = nil, newkey = nil) { ... }

Rename a key, only if the new key does not exist

Parameters:

  • key (String) (defaults to: nil)
    Key string to be renamed
  • newkey (String) (defaults to: nil)
    New key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1588
1589
1590
1591
1592
1593
1594
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1588

def renamenx(key=nil,newkey=nil)
  if key.class == String && newkey.class == String && block_given?
    @j_del.java_method(:renamenx, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,newkey,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling renamenx(#{key},#{newkey})"
end

- (self) restore(key = nil, millis = nil, serialized = nil) { ... }

Create a key using the provided serialized value, previously obtained using DUMP.

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • millis (Fixnum) (defaults to: nil)
    Expiry time in milliseconds to set on the key
  • serialized (String) (defaults to: nil)
    Serialized form of the key value as obtained using DUMP

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1601
1602
1603
1604
1605
1606
1607
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1601

def restore(key=nil,millis=nil,serialized=nil)
  if key.class == String && millis.class == Fixnum && serialized.class == String && block_given?
    @j_del.java_method(:restore, [Java::java.lang.String.java_class,Java::long.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,millis,serialized,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling restore(#{key},#{millis},#{serialized})"
end

- (self) role { ... }

Return the role of the instance in the context of replication

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


1611
1612
1613
1614
1615
1616
1617
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1611

def role
  if block_given?
    @j_del.java_method(:role, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result != nil ? JSON.parse(ar.result.encode) : nil : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling role()"
end

- (self) rpop(key = nil) { ... }

Remove and get the last element in a list

Parameters:

  • key (String) (defaults to: nil)
    Key string

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1622
1623
1624
1625
1626
1627
1628
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1622

def rpop(key=nil)
  if key.class == String && block_given?
    @j_del.java_method(:rpop, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling rpop(#{key})"
end

- (self) rpoplpush(key = nil, destkey = nil) { ... }

Remove the last element in a list, append it to another list and return it

Parameters:

  • key (String) (defaults to: nil)
    Key string identifying source list
  • destkey (String) (defaults to: nil)
    Key string identifying destination list

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1634
1635
1636
1637
1638
1639
1640
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1634

def rpoplpush(key=nil,destkey=nil)
  if key.class == String && destkey.class == String && block_given?
    @j_del.java_method(:rpoplpush, [Java::java.lang.String.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(key,destkey,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling rpoplpush(#{key},#{destkey})"
end

- (self) rpush(key = nil, value = nil) { ... }

Append one or multiple values to a list

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • value (String) (defaults to: nil)
    Value to be added to the end of the list

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1658
1659
1660
1661
1662
1663
1664
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1658

def rpush(