Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- await() - Method in class net.swofty.redisapi.api.requests.DataRequest
-
Publishes the request and returns a future that completes the moment a response arrives (or after 1000Lms with a null response, same as before) - without ever blocking or parking a thread while waiting.
B
- build(Map) - Static method in class net.swofty.redisapi.util.RedisParsableMessage
- build(JSONObject) - Static method in class net.swofty.redisapi.util.RedisParsableMessage
C
- channel - Variable in class net.swofty.redisapi.events.RedisMessagingReceiveEvent
- CHANNEL - Static variable in class net.swofty.redisapi.api.requests.DataRequest
-
The internal channel every request and response travels over.
- ChannelAlreadyRegisteredException - Exception Class in net.swofty.redisapi.exceptions
- ChannelAlreadyRegisteredException(String) - Constructor for exception class net.swofty.redisapi.exceptions.ChannelAlreadyRegisteredException
- ChannelDefinitionError - Exception Class in net.swofty.redisapi.exceptions
-
This class is a custom exception that is thrown when a channel definition is invalid, this is usually because there is no event consumer or class passed through
- ChannelDefinitionError(String) - Constructor for exception class net.swofty.redisapi.exceptions.ChannelDefinitionError
- ChannelFunctionType - Enum Class in net.swofty.redisapi.api
- channelName - Variable in class net.swofty.redisapi.api.RedisChannel
-
Name of the channel that messages are sent through
- ChannelNotRegisteredException - Exception Class in net.swofty.redisapi.exceptions
-
This class is a custom exception class that is thrown when a class is not registered yet there is a message trying to be sent through it
- ChannelNotRegisteredException(String) - Constructor for exception class net.swofty.redisapi.exceptions.ChannelNotRegisteredException
- ChannelRegistry - Class in net.swofty.redisapi.api
- ChannelRegistry() - Constructor for class net.swofty.redisapi.api.ChannelRegistry
- CLASS - Enum constant in enum class net.swofty.redisapi.api.ChannelFunctionType
- completions() - Static method in class net.swofty.redisapi.api.RedisExecutors
-
Stages of the futures handed out by
DataRequestandpublishMessage. - CONSUMER - Enum constant in enum class net.swofty.redisapi.api.ChannelFunctionType
- CouldNotConnectToRedisException - Exception Class in net.swofty.redisapi.exceptions
-
This class is a custom exception class that throws when Jedis process is unable to connect to Redis
- CouldNotConnectToRedisException(String) - Constructor for exception class net.swofty.redisapi.exceptions.CouldNotConnectToRedisException
- create(String, Function) - Static method in class net.swofty.redisapi.api.requests.DataRequestResponder
-
Create a responder to a data request, so when a data request with a specified key gets sent to this server, it'll respond back.
D
- data() - Method in record class net.swofty.redisapi.api.requests.DataResponse
-
Returns the value of the
datarecord component. - DataRequest - Class in net.swofty.redisapi.api.requests
- DataRequest(String, String, JSONObject) - Constructor for class net.swofty.redisapi.api.requests.DataRequest
-
Create a new data request to get a specific object of data from a specific server.
- DataRequest.StreamType - Enum Class in net.swofty.redisapi.api.requests
- DataRequestResponder - Class in net.swofty.redisapi.api.requests
- DataRequestResponder(Function) - Constructor for class net.swofty.redisapi.api.requests.DataRequestResponder
- DataResponse - Record Class in net.swofty.redisapi.api.requests
-
The response to a DataRequest.
- DataResponse(JSONObject, long) - Constructor for record class net.swofty.redisapi.api.requests.DataResponse
-
Creates an instance of a
DataResponserecord class. - DataStreamListener - Class in net.swofty.redisapi.api.requests
-
Internal use, not for outside API
- DataStreamListener() - Constructor for class net.swofty.redisapi.api.requests.DataStreamListener
- dispatch(String, String) - Static method in class net.swofty.redisapi.events.EventRegistry
-
Entry point for the subscriber thread.
- dispatchFor(String) - Static method in class net.swofty.redisapi.api.RedisExecutors
-
The single-threaded stripe a channel's messages are handled on.
E
- equals(Object) - Method in record class net.swofty.redisapi.api.RedisCredentials
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class net.swofty.redisapi.api.requests.DataResponse
-
Indicates whether some other object is "equal to" this one.
- EventRegistry - Class in net.swofty.redisapi.events
- EventRegistry() - Constructor for class net.swofty.redisapi.events.EventRegistry
F
- formatForSend() - Method in class net.swofty.redisapi.util.RedisParsableMessage
-
Formats the RedisParsableMessage into a string to be sent through Redis
- functionType - Variable in class net.swofty.redisapi.api.RedisChannel
-
Used to determine what type of function is being used to receive messages.
G
- generateInstance(String) - Static method in class net.swofty.redisapi.api.RedisAPI
-
Creates a new main Redis pool instance, there will only ever be one at a time so #getInstance should be used after generation
- generateInstance(String, String) - Static method in class net.swofty.redisapi.api.RedisAPI
-
Creates a new main Redis pool instance, there will only ever be one at a time so #getInstance should be used after generation
- generateInstance(RedisCredentials) - Static method in class net.swofty.redisapi.api.RedisAPI
-
Creates a new main Redis pool instance, there will only ever be one at a time so #getInstance should be used after generation
- get(String) - Static method in class net.swofty.redisapi.api.requests.DataRequestResponder
-
Get a responder by its unique key.
- get(String, T) - Method in class net.swofty.redisapi.util.RedisParsableMessage
- getBoolean(String) - Method in class net.swofty.redisapi.util.RedisParsableMessage
- getFromName(String) - Method in class net.swofty.redisapi.api.ChannelRegistry
-
Used to receive a channel that has already been registered
- getJsonArray(String) - Method in class net.swofty.redisapi.util.RedisParsableMessage
- getStringList(String) - Method in class net.swofty.redisapi.util.RedisParsableMessage
- getUUID(String) - Method in class net.swofty.redisapi.util.RedisParsableMessage
H
- handleAll(String, String) - Static method in class net.swofty.redisapi.events.EventRegistry
- handlers() - Static method in class net.swofty.redisapi.api.RedisExecutors
-
DataRequestRespondercallbacks, which may block on IO. - hashCode() - Method in record class net.swofty.redisapi.api.RedisCredentials
-
Returns a hash code value for this object.
- hashCode() - Method in record class net.swofty.redisapi.api.requests.DataResponse
-
Returns a hash code value for this object.
- host() - Method in record class net.swofty.redisapi.api.RedisCredentials
-
Returns the value of the
hostrecord component.
I
- inbound() - Static method in class net.swofty.redisapi.api.RedisExecutors
-
Envelope work for the internal data request channel, which never blocks.
- InvalidMessageException - Exception Class in net.swofty.redisapi.exceptions
- InvalidMessageException(String) - Constructor for exception class net.swofty.redisapi.exceptions.InvalidMessageException
L
- latency() - Method in record class net.swofty.redisapi.api.requests.DataResponse
-
Returns the value of the
latencyrecord component.
M
- message - Variable in class net.swofty.redisapi.events.RedisMessagingReceiveEvent
- MessageFailureException - Exception Class in net.swofty.redisapi.exceptions
- MessageFailureException(String, Throwable) - Constructor for exception class net.swofty.redisapi.exceptions.MessageFailureException
N
- net.swofty.redisapi.api - package net.swofty.redisapi.api
- net.swofty.redisapi.api.requests - package net.swofty.redisapi.api.requests
- net.swofty.redisapi.events - package net.swofty.redisapi.events
- net.swofty.redisapi.exceptions - package net.swofty.redisapi.exceptions
- net.swofty.redisapi.util - package net.swofty.redisapi.util
O
- onMessage(String, String) - Method in class net.swofty.redisapi.api.requests.DataStreamListener
- onMessage(String, String) - Method in interface net.swofty.redisapi.events.RedisMessagingReceiveInterface
P
- parse(String) - Static method in class net.swofty.redisapi.util.RedisParsableMessage
-
Wraps Redis messages into
RedisParsableMessagemaking it effectively aJSONObject - password() - Method in record class net.swofty.redisapi.api.RedisCredentials
-
Returns the value of the
passwordrecord component. - port() - Method in record class net.swofty.redisapi.api.RedisCredentials
-
Returns the value of the
portrecord component. - publisher() - Static method in class net.swofty.redisapi.api.RedisExecutors
-
Outbound publishes.
- publishMessage(String, RedisChannel, String) - Method in class net.swofty.redisapi.api.RedisAPI
-
Asynchronously publishes a message to the generated instances redis pool
- publishMessage(RedisChannel, String) - Method in class net.swofty.redisapi.api.RedisAPI
-
Asynchronously publishes a message to the generated instances redis pool
- pubSub - Static variable in class net.swofty.redisapi.events.EventRegistry
R
- receive(String, JSONObject) - Static method in class net.swofty.redisapi.api.requests.DataRequest
-
Called by whatever listens for incoming Redis messages when a
RESPONSE-stream message with a matching id comes back. - receiveEvent - Variable in class net.swofty.redisapi.api.RedisChannel
-
Consumer that contains the function ran when a message is received on this channel
- receiveInterface - Variable in class net.swofty.redisapi.api.RedisChannel
-
Class that contains the function ran when a message is received on this channel
- RedisAPI - Class in net.swofty.redisapi.api
- RedisAPI() - Constructor for class net.swofty.redisapi.api.RedisAPI
- RedisChannel - Class in net.swofty.redisapi.api
- RedisChannel(String, Class) - Constructor for class net.swofty.redisapi.api.RedisChannel
- RedisChannel(String, Consumer) - Constructor for class net.swofty.redisapi.api.RedisChannel
- RedisCredentials - Record Class in net.swofty.redisapi.api
- RedisCredentials(String, int, String, boolean) - Constructor for record class net.swofty.redisapi.api.RedisCredentials
- RedisCredentials(String, int, String, String, boolean) - Constructor for record class net.swofty.redisapi.api.RedisCredentials
-
Creates an instance of a
RedisCredentialsrecord class. - RedisExecutors - Class in net.swofty.redisapi.api
-
Owns every worker thread the Redis layer uses.
- RedisMessagingReceiveEvent - Class in net.swofty.redisapi.events
- RedisMessagingReceiveInterface - Interface in net.swofty.redisapi.events
- RedisParsableMessage - Class in net.swofty.redisapi.util
-
This utility class is used for sending JSONObjects over Redis instead of working with raw Strings.
- RedisParsableMessage(JSONObject) - Constructor for class net.swofty.redisapi.util.RedisParsableMessage
- registerChannel(String, Class) - Method in class net.swofty.redisapi.api.RedisAPI
-
Used to register a redis channel, this must be done before sending any messages on this channel
- registerChannel(String, Consumer) - Method in class net.swofty.redisapi.api.RedisAPI
-
Used to register a redis channel, this must be done before sending any messages on this channel
- registerChannel(RedisChannel) - Method in class net.swofty.redisapi.api.ChannelRegistry
- registeredChannels - Variable in class net.swofty.redisapi.api.ChannelRegistry
- REQUEST - Enum constant in enum class net.swofty.redisapi.api.requests.DataRequest.StreamType
- respond(JSONObject) - Method in class net.swofty.redisapi.api.requests.DataRequestResponder
-
Respond to a received request.
- RESPONDERS - Static variable in class net.swofty.redisapi.api.requests.DataRequestResponder
- RESPONSE - Enum constant in enum class net.swofty.redisapi.api.requests.DataRequest.StreamType
S
- shutdown() - Method in class net.swofty.redisapi.api.RedisAPI
-
Stops the Pub/Sub listener thread (if running), closes the pool, and shuts down the worker pools.
- shutdown() - Static method in class net.swofty.redisapi.api.RedisExecutors
-
Stops accepting new work on the current pools and lets queued work drain.
- ssl() - Method in record class net.swofty.redisapi.api.RedisCredentials
-
Returns the value of the
sslrecord component. - startListeners() - Method in class net.swofty.redisapi.api.RedisAPI
-
Starts listeners for the Redis Pub/Sub channels.
T
- timestamp - Variable in class net.swofty.redisapi.api.RedisChannel
-
Timestamp in Unix milliseconds of when the channel last had a message received through it
- toString() - Method in record class net.swofty.redisapi.api.RedisCredentials
-
Returns a string representation of this record class.
- toString() - Method in record class net.swofty.redisapi.api.requests.DataResponse
-
Returns a string representation of this record class.
U
- user() - Method in record class net.swofty.redisapi.api.RedisCredentials
-
Returns the value of the
userrecord component.
V
- valueOf(String) - Static method in enum class net.swofty.redisapi.api.ChannelFunctionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class net.swofty.redisapi.api.requests.DataRequest.StreamType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class net.swofty.redisapi.api.ChannelFunctionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class net.swofty.redisapi.api.requests.DataRequest.StreamType
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form