<!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`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>redis.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../actix_redis/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../actix_redis/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../actix_redis/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
</pre><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="attribute">#[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></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_redis" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (eaadb8947 2022-08-27)" ></div></body></html>