1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
//! The `net_box` module contains connector to remote Tarantool server instances via a network.
//!
//! You can call the following methods:
//! - [Conn::new()](struct.Conn.html#method.new) to connect and get a connection object (named `conn` for examples in this section),
//! - other `net_box` routines, to execute requests on the remote database system,
//! - [conn.close()](struct.Conn.html#method.close) to disconnect.
//!
//! All [Conn](struct.Conn.html) methods are fiber-safe, that is, it is safe to share and use the same connection object
//! across multiple concurrent fibers. In fact that is perhaps the best programming practice with Tarantool. When
//! multiple fibers use the same connection, all requests are pipelined through the same network socket, but each fiber
//! gets back a correct response. Reducing the number of active sockets lowers the overhead of system calls and increases
//! the overall server performance. However for some cases a single connection is not enough — for example, when it is
//! necessary to prioritize requests or to use different authentication IDs.
//!
//! Most [Conn](struct.Conn.html) methods allow a `options` argument. See [Options](struct.Options.html) structure docs
//! for details.
//!
//! The diagram below shows possible connection states and transitions:
//! ```text
//! connecting -> initial +-> active
//! \
//! +-> auth -> fetch_schema <-> active
//!
//! (any state, on error) -> error_reconnect -> connecting -> ...
//! \
//! -> [error]
//! (any_state, but [error]) -> [closed]
//! ```
//!
//! On this diagram:
//! - The state machine starts in the `initial` state.
//! - [Conn::new()](struct.Conn.html#method.new) method changes the state to `connecting` and spawns a worker fiber.
//! - If authentication and schema upload are required, it’s possible later on to re-enter the `fetch_schema` state
//! from `active` if a request fails due to a schema version mismatch error, so schema reload is triggered.
//! - [conn.close()](struct.Conn.html#method.close) method sets the state to `closed` and kills the worker. If the
//! transport is already in the `error` state, [close()](struct.Conn.html#method.close) does nothing.
//!
//! See also:
//! - [Lua reference: Module net.box](https://www.tarantool.io/en/doc/latest/reference/reference_lua/net_box/)
#![cfg(feature = "net_box")]
use core::time::Duration;
use std::net::ToSocketAddrs;
use std::rc::Rc;
pub use index::{RemoteIndex, RemoteIndexIterator};
use inner::ConnInner;
pub use options::{ConnOptions, ConnTriggers, Options};
pub(crate) use protocol::ResponseError;
use promise::Promise;
pub use space::RemoteSpace;
use crate::error::Error;
use crate::tuple::{AsTuple, Decode, Tuple};
mod index;
mod inner;
mod options;
pub mod promise;
mod protocol;
mod recv_queue;
mod schema;
mod send_queue;
mod space;
mod stream;
/// Connection to remote Tarantool server
pub struct Conn {
inner: Rc<ConnInner>,
is_master: bool,
}
impl Conn {
/// Create a new connection.
///
/// The connection is established on demand, at the time of the first request. It can be re-established
/// automatically after a disconnect (see [reconnect_after](struct.ConnOptions.html#structfield.reconnect_after) option).
/// The returned conn object supports methods for making remote requests, such as select, update or delete.
///
/// See also: [ConnOptions](struct.ConnOptions.html)
pub fn new(
addr: impl ToSocketAddrs,
options: ConnOptions,
triggers: Option<Rc<dyn ConnTriggers>>,
) -> Result<Self, Error> {
Ok(Conn {
inner: ConnInner::new(addr.to_socket_addrs()?.collect(), options, triggers),
is_master: true,
})
}
fn downgrade(inner: Rc<ConnInner>) -> Self {
Conn {
inner,
is_master: false,
}
}
/// Wait for connection to be active or closed.
///
/// Returns:
/// - `Ok(true)`: if active
/// - `Ok(true)`: if closed
/// - `Err(...TimedOut...)`: on timeout
pub fn wait_connected(&self, timeout: Option<Duration>) -> Result<bool, Error> {
self.inner.wait_connected(timeout)
}
/// Show whether connection is active or closed.
pub fn is_connected(&self) -> bool {
self.inner.is_connected()
}
/// Close a connection.
pub fn close(&self) {
self.inner.close()
}
/// Execute a PING command.
///
/// - `options` – the supported option is `timeout`
pub fn ping(&self, options: &Options) -> Result<(), Error> {
self.inner
.request(protocol::encode_ping, |_, _| Ok(()), options)?;
Ok(())
}
/// Call a remote stored procedure.
///
/// `conn.call("func", &("1", "2", "3"))` is the remote-call equivalent of `func('1', '2', '3')`.
/// That is, `conn.call` is a remote stored-procedure call.
/// The return from `conn.call` is whatever the function returns.
pub fn call<T>(
&self,
function_name: &str,
args: &T,
options: &Options,
) -> Result<Option<Tuple>, Error>
where
T: AsTuple,
T: ?Sized,
{
self.inner.request(
|buf, sync| protocol::encode_call(buf, sync, function_name, args),
protocol::decode_call,
options,
)
}
/// Call a remote stored procedure without yielding.
///
/// If enqueuing a request succeeded a [`Promise`] is returned which will be
/// kept once a response is received.
pub fn call_async<A, R>(&self, func: &str, args: A) -> crate::Result<Promise<R>>
where
A: AsTuple,
R: Decode + 'static,
{
self.inner.request_async(protocol::Call(func, args))
}
/// Evaluates and executes the expression in Lua-string, which may be any statement or series of statements.
///
/// An execute privilege is required; if the user does not have it, an administrator may grant it with
/// `box.schema.user.grant(username, 'execute', 'universe')`.
///
/// To ensure that the return from `eval` is whatever the Lua expression returns, begin the Lua-string with the
/// word `return`.
pub fn eval<T>(
&self,
expression: &str,
args: &T,
options: &Options,
) -> Result<Option<Tuple>, Error>
where
T: AsTuple,
T: ?Sized,
{
self.inner.request(
|buf, sync| protocol::encode_eval(buf, sync, expression, args),
protocol::decode_call,
options,
)
}
/// Executes a series of lua statements on a remote host without yielding.
///
/// If enqueuing a request succeeded a [`Promise`] is returned which will be
/// kept once a response is received.
pub fn eval_async<A, R>(&self, expr: &str, args: A) -> crate::Result<Promise<R>>
where
A: AsTuple,
R: Decode + 'static,
{
self.inner.request_async(protocol::Eval(expr, args))
}
/// Search space by name on remote server
pub fn space(&self, name: &str) -> Result<Option<RemoteSpace>, Error> {
Ok(self
.inner
.lookup_space(name)?
.map(|space_id| RemoteSpace::new(self.inner.clone(), space_id)))
}
}
impl Drop for Conn {
fn drop(&mut self) {
if self.is_master {
self.close();
}
}
}