Struct ConnectionHandler

pub struct ConnectionHandler<N: TcpClientStack, P: Protocol>
where
    HelloCommand: Command<<P as Protocol>::FrameType>,
{ /* private fields */ }

Connection handler for Redis client

While the Client is not Send, the connection handler is. The handler is designed with the approach that the creation of new clients is cheap. Thus, the use of short-lived clients in concurrent applications is not a problem.

Implementations

impl<N: TcpClientStack> ConnectionHandler<N, Resp2>

pub fn resp2(remote: SocketAddr) -> ConnectionHandler<N, Resp2>

Creates a new connection handler using RESP2 protocol

impl<N: TcpClientStack> ConnectionHandler<N, Resp3>

pub fn resp3(remote: SocketAddr) -> ConnectionHandler<N, Resp3>

Creates a new connection handler using RESP3 protocol

impl<N: TcpClientStack, P: Protocol> ConnectionHandler<N, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>, PingCommand: Command<<P as Protocol>::FrameType>, <P as Protocol>::FrameType: ToStringOption + From<CommandBuilder>,

pub fn connect<'a, C: Clock>( &'a mut self, network: &'a mut N, clock: Option<&'a C>, ) -> Result<Client<'a, N, C, P>, ConnectionError>

Returns a Redis client. Caches the connection for future reuse. The client has the same lifetime as the network reference.

As the connection is cached, later calls are cheap. So a new client may be created when switching threads, RISC tasks, etc.

Authentication Authentication is done automatically when creating a new connection. So the caller can expect a already authenticated and read2use client

Arguments

• network: Mutable borrow of embedded-nal network stack
• clock: Borrow of embedded-time clock

returns: Result<Client<N, C, P>, ConnectionError>

pub fn disconnect(&mut self, network: &mut N)

Disconnects the connection

impl<N: TcpClientStack, P: Protocol> ConnectionHandler<N, P>

where HelloCommand: Command<<P as Protocol>::FrameType>,

pub fn timeout(&mut self, timeout: Microseconds) -> &mut Self

Sets the max. duration waiting for Redis responses

pub fn auth(&mut self, credentials: Credentials) -> &mut Self

Sets the authentication credentials

pub fn use_ping(&mut self) -> &mut Self

Using PING command for testing connections

pub fn memory(&mut self, parameters: MemoryParameters) -> &mut Self

Sets memory allocation parameters