Connection
abstract class Connection (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Redis | $client | The Redis client. |
|
| protected string|null | $name | The Redis connection name. |
|
| protected Dispatcher | $events | The event dispatcher instance. |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Pass other method calls down to the underlying client.
Subscribe to a set of given channels for messages.
Funnel a callback for a maximum number of simultaneous executions.
Throttle a callback for a maximum number of executions over a given duration.
Get the underlying Redis client.
Subscribe to a set of given channels with wildcards.
Run a command against the Redis database.
Parse the command's parameters for event dispatching.
Fire the given event if possible.
Get the connection name.
Set the connections name.
Get the event dispatcher used by the connection.
Unset the event dispatcher instance on the connection.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Pass other method calls down to the underlying client.
abstract void
createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')
Subscribe to a set of given channels for messages.
ConcurrencyLimiterBuilder
funnel(string $name)
Funnel a callback for a maximum number of simultaneous executions.
DurationLimiterBuilder
throttle(string $name)
Throttle a callback for a maximum number of executions over a given duration.
mixed
client()
Get the underlying Redis client.
void
subscribe(array|string $channels, Closure $callback)
Subscribe to a set of given channels for messages.
void
psubscribe(array|string $channels, Closure $callback)
Subscribe to a set of given channels with wildcards.
mixed
command(string $method, array $parameters = [])
Run a command against the Redis database.
protected array
parseParametersForEvent(array $parameters)
Parse the command's parameters for event dispatching.
protected void
event(mixed $event)
Fire the given event if possible.
void
listen(Closure $callback)
Register a Redis command listener with the connection.
string|null
getName()
Get the connection name.
$this
setName(string $name)
Set the connections name.
Dispatcher
getEventDispatcher()
Get the event dispatcher used by the connection.
void
setEventDispatcher(Dispatcher $events)
Set the event dispatcher instance on the connection.
void
unsetEventDispatcher()
Unset the event dispatcher instance on the connection.