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)


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

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)


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

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



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

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



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

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

+ (Object) unwrap(obj)



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

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

+ (Object) wrap(obj)



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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


2822
2823
2824
2825
2826
2827
2828
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2822

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)


2835
2836
2837
2838
2839
2840
2841
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2835

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


2765
2766
2767
2768
2769
2770
2771
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2765

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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) 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)


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

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)


753
754
755
756
757
758
759
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 753

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)


765
766
767
768
769
770
771
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 765

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)


777
778
779
780
781
782
783
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 777

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)


787
788
789
790
791
792
793
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 787

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)


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

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)


2597
2598
2599
2600
2601
2602
2603
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2597

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)


2609
2610
2611
2612
2613
2614
2615
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2609

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)


2674
2675
2676
2677
2678
2679
2680
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2674

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)


2688
2689
2690
2691
2692
2693
2694
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2688

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)


2622
2623
2624
2625
2626
2627
2628
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2622

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)


2635
2636
2637
2638
2639
2640
2641
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2635

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)


2648
2649
2650
2651
2652
2653
2654
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2648

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)


2661
2662
2663
2664
2665
2666
2667
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2661

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)


2704
2705
2706
2707
2708
2709
2710
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2704

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)


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

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)


2737
2738
2739
2740
2741
2742
2743
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2737

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)


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

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)


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

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)


819
820
821
822
823
824
825
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 819

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)


831
832
833
834
835
836
837
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 831

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)


844
845
846
847
848
849
850
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 844

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)


856
857
858
859
860
861
862
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 856

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)


868
869
870
871
872
873
874
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 868

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)


880
881
882
883
884
885
886
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 880

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)


892
893
894
895
896
897
898
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 892

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)


904
905
906
907
908
909
910
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 904

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)


915
916
917
918
919
920
921
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 915

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)


928
929
930
931
932
933
934
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 928

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)


941
942
943
944
945
946
947
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 941

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)


952
953
954
955
956
957
958
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 952

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)


963
964
965
966
967
968
969
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 963

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)


975
976
977
978
979
980
981
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 975

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)


987
988
989
990
991
992
993
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 987

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)


2570
2571
2572
2573
2574
2575
2576
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2570

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)


1000
1001
1002
1003
1004
1005
1006
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1000

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)


1013
1014
1015
1016
1017
1018
1019
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1013

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)


2777
2778
2779
2780
2781
2782
2783
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 2777

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)


1024
1025
1026
1027
1028
1029
1030
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1024

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)


1035
1036
1037
1038
1039
1040
1041
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1035

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)


1047
1048
1049
1050
1051
1052
1053
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1047

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)


1059
1060
1061
1062
1063
1064
1065
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1059

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)


1069
1070
1071
1072
1073
1074
1075
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1069

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)


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

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)


1091
1092
1093
1094
1095
1096
1097
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1091

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)


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

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)


1113
1114
1115
1116
1117
1118
1119
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1113

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)


1127
1128
1129
1130
1131
1132
1133
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1127

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)


1138
1139
1140
1141
1142
1143
1144
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1138

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)


1149
1150
1151
1152
1153
1154
1155
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1149

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)


1173
1174
1175
1176
1177
1178
1179
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1173

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)


1161
1162
1163
1164
1165
1166
1167
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1161

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)


1185
1186
1187
1188
1189
1190
1191
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1185

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)


1198
1199
1200
1201
1202
1203
1204
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1198

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)


1211
1212
1213
1214
1215
1216
1217
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1211

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)


1224
1225
1226
1227
1228
1229
1230
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1224

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)


1237
1238
1239
1240
1241
1242
1243
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1237

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)


1248
1249
1250
1251
1252
1253
1254
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1248

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)


1259
1260
1261
1262
1263
1264
1265
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1259

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)


1275
1276
1277
1278
1279
1280
1281
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1275

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)


1285
1286
1287
1288
1289
1290
1291
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1285

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)


1297
1298
1299
1300
1301
1302
1303
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1297

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)


1308
1309
1310
1311
1312
1313
1314
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1308

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)


1319
1320
1321
1322
1323
1324
1325
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1319

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)


1331
1332
1333
1334
1335
1336
1337
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1331

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)


1342
1343
1344
1345
1346
1347
1348
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1342

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)


1354
1355
1356
1357
1358
1359
1360
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1354

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)


1366
1367
1368
1369
1370
1371
1372
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1366

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)


1378
1379
1380
1381
1382
1383
1384
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1378

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)


1390
1391
1392
1393
1394
1395
1396
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1390

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)


1401
1402
1403
1404
1405
1406
1407
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1401

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)


1412
1413
1414
1415
1416
1417
1418
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1412

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)


1424
1425
1426
1427
1428
1429
1430
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1424

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)


1434
1435
1436
1437
1438
1439
1440
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1434

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)


1447
1448
1449
1450
1451
1452
1453
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1447

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)


1458
1459
1460
1461
1462
1463
1464
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1458

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)


1469
1470
1471
1472
1473
1474
1475
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1469

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)


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

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)


1524
1525
1526
1527
1528
1529
1530
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1524

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)


1480
1481
1482
1483
1484
1485
1486
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1480

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)


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

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)


1491
1492
1493
1494
1495
1496
1497
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1491

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)


1535
1536
1537
1538
1539
1540
1541
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1535

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)


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

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)


1557
1558
1559
1560
1561
1562
1563
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1557

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)


1569
1570
1571
1572
1573
1574
1575
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1569

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)


1582
1583
1584
1585
1586
1587
1588
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1582

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)


1592
1593
1594
1595
1596
1597
1598
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1592

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)


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

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)


1615
1616
1617
1618
1619
1620
1621
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1615

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)


1639
1640
1641
1642
1643
1644
1645
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1639

def rpush(key=nil,value=nil)
  if key.class == String && value.class == String && block_given?
    @j_del.java_method(:rpush, [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 rpush(#{key},#{value})"
end

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

Append one or multiple values to a list

Parameters:

  • key (String) (defaults to: nil)
    Key string
  • values (Array<String>) (defaults to: nil)
    List of values to add to the end of the list

Yields:

  • Handler for the result of this call.

Returns:

  • (self)

Raises:

  • (ArgumentError)


1627
1628
1629
1630
1631
1632
1633
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-redis/redis_client.rb', line 1627

def rpush_many(key=nil,values=nil)
  if key.class == String && values.class == Array && block_given?
    @j_del.java_method(:rpushMany, [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 rpush_many(#{key},#{values})"
end