RedisSource {ipc}R Documentation

Reads and writes the queue to a redis db

Description

Reads and writes the queue to a redis db

Reads and writes the queue to a redis db

Methods

Public methods


Method new()

Creates a redis source object.

Usage
RedisSource$new(id = redisIdGenerator()(), config = redisConfig())
Arguments
id

An identifier to use for the queue

config

A configuration list for redux::hiredis


Method getRedisConnection()

Returns the underlying redis connection.

Usage
RedisSource$getRedisConnection()

Method pop()

removes n items from the source and returns them

Usage
RedisSource$pop(n = -1)
Arguments
n

The number of records to pop (-1 indicates all available).


Method push()

Adds an item to the source.

Usage
RedisSource$push(msg, obj)
Arguments
msg

A string indicating the signal.

obj

The object to associate with the signal.


Method destroy()

Cleans up source after use.

Usage
RedisSource$destroy()

Method finalize()

finalize

Usage
RedisSource$finalize()

Method clone()

The objects of this class are cloneable with this method.

Usage
RedisSource$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


[Package ipc version 0.1.4 Index]