public class KillArgs extends Object implements CompositeArgument
KillArgs.Builder
and chain the method calls: id(1).skipme()
.
KillArgs
is a mutable object and instances should be used only once to avoid shared mutable state.
Modifier and Type | Class and Description |
---|---|
static class |
KillArgs.Builder
Builder entry points for
KillArgs . |
Constructor and Description |
---|
KillArgs() |
Modifier and Type | Method and Description |
---|---|
KillArgs |
addr(String addr)
Kill the client at
addr (Remote Address). |
<K,V> void |
build(CommandArgs<K,V> args)
Build command arguments and contribute arguments to
CommandArgs . |
KillArgs |
id(long id)
Kill the client with its client
id . |
KillArgs |
laddr(String laddr)
Kill the client at
laddr (Local Address). |
KillArgs |
skipme()
By default this option is enabled, that is, the client calling the command will not get killed, however setting this
option to no will have the effect of also killing the client calling the command.
|
KillArgs |
skipme(boolean state)
By default this option is enabled, that is, the client calling the command will not get killed, however setting this
option to no will have the effect of also killing the client calling the command.
|
KillArgs |
type(io.lettuce.core.KillArgs.Type type)
This closes the connections of all the clients in the specified
KillArgs.Type . |
KillArgs |
user(String username)
Closes all the connections that are authenticated with the specified ACL
username . |
public KillArgs skipme()
this
MigrateArgs
.public KillArgs skipme(boolean state)
state
- this
KillArgs
.public KillArgs addr(String addr)
addr
(Remote Address).addr
- must not be null
.this
KillArgs
.public KillArgs laddr(String laddr)
laddr
(Local Address).laddr
- must not be null
.this
KillArgs
.public KillArgs id(long id)
id
.id
- this
KillArgs
.public KillArgs type(io.lettuce.core.KillArgs.Type type)
KillArgs.Type
. Note that clients blocked into the
MONITOR command are considered to belong to the normal class.type
- must not be null
.this
KillArgs
.public KillArgs user(String username)
username
.username
- must not be null
.this
KillArgs
.public <K,V> void build(CommandArgs<K,V> args)
CompositeArgument
CommandArgs
.
Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.
build
in interface CompositeArgument
K
- Key type.V
- Value type.args
- the command arguments, must not be null
.Copyright © 2022 lettuce.io. All rights reserved.