<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `actix-redis/src/redis.rs`."><title>redis.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-bf502f66ec635d5d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_redis" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.0-nightly (e51e98dde 2023-12-31)" data-channel="nightly" data-search-js="search-c17e98913a53b3b7.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-0b2e2def73e61cbe.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title">
<h2>Files</h2></div></nav><div class="sidebar-resizer"></div>
<main><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../actix_redis/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
</pre></div><pre class="rust"><code><span class="kw">use </span>std::{collections::VecDeque, io};
<span class="kw">use </span>actix::prelude::<span class="kw-2">*</span>;
<span class="kw">use </span>actix_rt::net::TcpStream;
<span class="kw">use </span>actix_service::boxed::{<span class="self">self</span>, BoxService};
<span class="kw">use </span>actix_tls::connect::{ConnectError, ConnectInfo, Connection, ConnectorService};
<span class="kw">use </span>backoff::{backoff::Backoff, ExponentialBackoff};
<span class="kw">use </span>log::{error, info, warn};
<span class="kw">use </span>redis_async::{
error::Error <span class="kw">as </span>RespError,
resp::{RespCodec, RespValue},
};
<span class="kw">use </span>tokio::{
io::{split, WriteHalf},
sync::oneshot,
};
<span class="kw">use </span>tokio_util::codec::FramedRead;
<span class="kw">use </span><span class="kw">crate</span>::Error;
<span class="doccomment">/// Command for sending data to Redis.
</span><span class="attr">#[derive(Debug)]
</span><span class="kw">pub struct </span>Command(<span class="kw">pub </span>RespValue);
<span class="kw">impl </span>Message <span class="kw">for </span>Command {
<span class="kw">type </span><span class="prelude-ty">Result </span>= <span class="prelude-ty">Result</span><RespValue, Error>;
}
<span class="doccomment">/// Redis communication actor.
</span><span class="kw">pub struct </span>RedisActor {
addr: String,
connector: BoxService<ConnectInfo<String>, Connection<String, TcpStream>, ConnectError>,
backoff: ExponentialBackoff,
cell: <span class="prelude-ty">Option</span><actix::io::FramedWrite<RespValue, WriteHalf<TcpStream>, RespCodec>>,
queue: VecDeque<oneshot::Sender<<span class="prelude-ty">Result</span><RespValue, Error>>>,
}
<span class="kw">impl </span>RedisActor {
<span class="doccomment">/// Start new `Supervisor` with `RedisActor`.
</span><span class="kw">pub fn </span>start<S: Into<String>>(addr: S) -> Addr<RedisActor> {
<span class="kw">let </span>addr = addr.into();
<span class="kw">let </span>backoff = ExponentialBackoff {
max_elapsed_time: <span class="prelude-val">None</span>,
..Default::default()
};
Supervisor::start(|<span class="kw">_</span>| RedisActor {
addr,
connector: boxed::service(ConnectorService::default()),
cell: <span class="prelude-val">None</span>,
backoff,
queue: VecDeque::new(),
})
}
}
<span class="kw">impl </span>Actor <span class="kw">for </span>RedisActor {
<span class="kw">type </span>Context = Context<<span class="self">Self</span>>;
<span class="kw">fn </span>started(<span class="kw-2">&mut </span><span class="self">self</span>, ctx: <span class="kw-2">&mut </span>Context<<span class="self">Self</span>>) {
<span class="kw">let </span>req = ConnectInfo::new(<span class="self">self</span>.addr.to_owned());
<span class="self">self</span>.connector
.call(req)
.into_actor(<span class="self">self</span>)
.map(|res, act, ctx| <span class="kw">match </span>res {
<span class="prelude-val">Ok</span>(conn) => {
<span class="kw">let </span>stream = conn.into_parts().<span class="number">0</span>;
<span class="macro">info!</span>(<span class="string">"Connected to redis server: {}"</span>, act.addr);
<span class="kw">let </span>(r, w) = split(stream);
<span class="comment">// configure write side of the connection
</span><span class="kw">let </span>framed = actix::io::FramedWrite::new(w, RespCodec, ctx);
act.cell = <span class="prelude-val">Some</span>(framed);
<span class="comment">// read side of the connection
</span>ctx.add_stream(FramedRead::new(r, RespCodec));
act.backoff.reset();
}
<span class="prelude-val">Err</span>(err) => {
<span class="macro">error!</span>(<span class="string">"Can not connect to redis server: {}"</span>, err);
<span class="comment">// re-connect with backoff time.
// we stop current context, supervisor will restart it.
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(timeout) = act.backoff.next_backoff() {
ctx.run_later(timeout, |<span class="kw">_</span>, ctx| ctx.stop());
}
}
})
.wait(ctx);
}
}
<span class="kw">impl </span>Supervised <span class="kw">for </span>RedisActor {
<span class="kw">fn </span>restarting(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&mut </span><span class="self">Self</span>::Context) {
<span class="self">self</span>.cell.take();
<span class="kw">for </span>tx <span class="kw">in </span><span class="self">self</span>.queue.drain(..) {
<span class="kw">let _ </span>= tx.send(<span class="prelude-val">Err</span>(Error::Disconnected));
}
}
}
<span class="kw">impl </span>actix::io::WriteHandler<io::Error> <span class="kw">for </span>RedisActor {
<span class="kw">fn </span>error(<span class="kw-2">&mut </span><span class="self">self</span>, err: io::Error, <span class="kw">_</span>: <span class="kw-2">&mut </span><span class="self">Self</span>::Context) -> Running {
<span class="macro">warn!</span>(<span class="string">"Redis connection dropped: {} error: {}"</span>, <span class="self">self</span>.addr, err);
Running::Stop
}
}
<span class="kw">impl </span>StreamHandler<<span class="prelude-ty">Result</span><RespValue, RespError>> <span class="kw">for </span>RedisActor {
<span class="kw">fn </span>handle(<span class="kw-2">&mut </span><span class="self">self</span>, msg: <span class="prelude-ty">Result</span><RespValue, RespError>, ctx: <span class="kw-2">&mut </span><span class="self">Self</span>::Context) {
<span class="kw">match </span>msg {
<span class="prelude-val">Err</span>(e) => {
<span class="kw">if let </span><span class="prelude-val">Some</span>(tx) = <span class="self">self</span>.queue.pop_front() {
<span class="kw">let _ </span>= tx.send(<span class="prelude-val">Err</span>(e.into()));
}
ctx.stop();
}
<span class="prelude-val">Ok</span>(val) => {
<span class="kw">if let </span><span class="prelude-val">Some</span>(tx) = <span class="self">self</span>.queue.pop_front() {
<span class="kw">let _ </span>= tx.send(<span class="prelude-val">Ok</span>(val));
}
}
}
}
}
<span class="kw">impl </span>Handler<Command> <span class="kw">for </span>RedisActor {
<span class="kw">type </span><span class="prelude-ty">Result </span>= ResponseFuture<<span class="prelude-ty">Result</span><RespValue, Error>>;
<span class="kw">fn </span>handle(<span class="kw-2">&mut </span><span class="self">self</span>, msg: Command, <span class="kw">_</span>: <span class="kw-2">&mut </span><span class="self">Self</span>::Context) -> <span class="self">Self</span>::Result {
<span class="kw">let </span>(tx, rx) = oneshot::channel();
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>cell) = <span class="self">self</span>.cell {
<span class="self">self</span>.queue.push_back(tx);
cell.write(msg.<span class="number">0</span>);
} <span class="kw">else </span>{
<span class="kw">let _ </span>= tx.send(<span class="prelude-val">Err</span>(Error::NotConnected));
}
Box::pin(<span class="kw">async move </span>{ rx.<span class="kw">await</span>.map_err(|<span class="kw">_</span>| Error::Disconnected)<span class="question-mark">? </span>})
}
}
</code></pre></div></section></main></body></html>