RedisSource

<p>Reads and writes the queue to a redis db</p>
<p>Reads and writes the queue to a redis db</p>

Provides tools for passing messages between R processes.
Shiny examples are provided showing how to perform useful tasks such as:
updating reactive values from within a future, progress bars for long running
async tasks, and interrupting async tasks based on user input.

Ian Fellows

Tools for Message Passing Between Processes

RedisSource function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/RedisSource%24new()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::RedisSource$new()"><code>RedisSource$new()</code></a></p></li>
<li><p><a href="/link/RedisSource%24getRedisConnection()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::RedisSource$getRedisConnection()"><code>RedisSource$getRedisConnection()</code></a></p></li>
<li><p><a href="/link/RedisSource%24pop()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::RedisSource$pop()"><code>RedisSource$pop()</code></a></p></li>
<li><p><a href="/link/RedisSource%24push()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::RedisSource$push()"><code>RedisSource$push()</code></a></p></li>
<li><p><a href="/link/RedisSource%24destroy()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::RedisSource$destroy()"><code>RedisSource$destroy()</code></a></p></li>
<li><p><a href="/link/RedisSource%24finalize()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::RedisSource$finalize()"><code>RedisSource$finalize()</code></a></p></li>
<li><p><a href="/link/RedisSource%24clone()?package=ipc&version=0.1.4" data-mini-rdoc="ipc::RedisSource$clone()"><code>RedisSource$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-RedisSource-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Creates a redis source object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RedisSource$new(id = redisIdGenerator()(), config = redisConfig())</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>id</code></dt>
<dd><p>An identifier to use for the queue</p></dd></dl></div></p><p>
<dt><code>config</code></dt>
<dd><p>A configuration list for redux::hiredis</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-RedisSource-getRedisConnection"></a></p><div class="section" id="method-getredisconnection-">
<h3>Method <code>getRedisConnection()</code></h3>
<p>Returns the underlying redis connection.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RedisSource$getRedisConnection()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-RedisSource-pop"></a></p><div class="section" id="method-pop-">
<h3>Method <code>pop()</code></h3>
<p>removes n items from the source and returns them</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RedisSource$pop(n = -1)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>n</code></dt>
<dd><p>The number of records to pop (-1 indicates all available).</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-RedisSource-push"></a></p><div class="section" id="method-push-">
<h3>Method <code>push()</code></h3>
<p>Adds an item to the source.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RedisSource$push(msg, obj)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>msg</code></dt>
<dd><p>A string indicating the signal.</p></dd></dl></div></p><p>
<dt><code>obj</code></dt>
<dd><p>The object to associate with the signal.</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-RedisSource-destroy"></a></p><div class="section" id="method-destroy-">
<h3>Method <code>destroy()</code></h3>
<p>Cleans up source after use.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RedisSource$destroy()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-RedisSource-finalize"></a></p><div class="section" id="method-finalize-">
<h3>Method <code>finalize()</code></h3>
<p>finalize</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RedisSource$finalize()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-RedisSource-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RedisSource$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Reads and writes the queue to a redis db — RedisSource


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-RedisSource-new'><code>RedisSource$new()</code></a></p></li>
<li><p><a href='#method-RedisSource-getRedisConnection'><code>RedisSource$getRedisConnection()</code></a></p></li>
<li><p><a href='#method-RedisSource-pop'><code>RedisSource$pop()</code></a></p></li>
<li><p><a href='#method-RedisSource-push'><code>RedisSource$push()</code></a></p></li>
<li><p><a href='#method-RedisSource-destroy'><code>RedisSource$destroy()</code></a></p></li>
<li><p><a href='#method-RedisSource-finalize'><code>RedisSource$finalize()</code></a></p></li>
<li><p><a href='#method-RedisSource-clone'><code>RedisSource$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-RedisSource-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Creates a redis source object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RedisSource$new(id = redisIdGenerator()(), config = redisConfig())</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>id</code></dt>
<dd><p>An identifier to use for the queue</p></dd>


<dt><code>config</code></dt>
<dd><p>A configuration list for redux::hiredis</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-RedisSource-getRedisConnection"></a></p><div class='section' id='method-getredisconnection-'>
<h3>Method <code>getRedisConnection()</code></h3>
<p>Returns the underlying redis connection.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RedisSource$getRedisConnection()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-RedisSource-pop"></a></p><div class='section' id='method-pop-'>
<h3>Method <code>pop()</code></h3>
<p>removes n items from the source and returns them</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RedisSource$pop(n = -1)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>n</code></dt>
<dd><p>The number of records to pop (-1 indicates all available).</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-RedisSource-push"></a></p><div class='section' id='method-push-'>
<h3>Method <code>push()</code></h3>
<p>Adds an item to the source.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RedisSource$push(msg, obj)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>msg</code></dt>
<dd><p>A string indicating the signal.</p></dd>


<dt><code>obj</code></dt>
<dd><p>The object to associate with the signal.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-RedisSource-destroy"></a></p><div class='section' id='method-destroy-'>
<h3>Method <code>destroy()</code></h3>
<p>Cleans up source after use.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RedisSource$destroy()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-RedisSource-finalize"></a></p><div class='section' id='method-finalize-'>
<h3>Method <code>finalize()</code></h3>
<p>finalize</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RedisSource$finalize()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-RedisSource-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RedisSource$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


RedisSource: Reads and writes the queue to a redis db

Description

Arguments

Methods

Public methods

Method `new()`

Usage

Arguments

Method `getRedisConnection()`

Usage

Method `pop()`

Usage

Arguments

Method `push()`

Usage

Arguments

Method `destroy()`

Usage

Method `finalize()`

Usage

Method `clone()`

Usage

Arguments

Description

Arguments

Methods

Public methods

Method new()

Usage

Arguments

Method getRedisConnection()

Usage

Method pop()

Usage

Arguments

Method push()

Usage

Arguments

Method destroy()

Usage

Method finalize()

Usage

Method clone()

Usage

Arguments

Method `new()`

Method `getRedisConnection()`

Method `pop()`

Method `push()`

Method `destroy()`

Method `finalize()`

Method `clone()`