Struct eventstore::ConnectionBuilder

pub struct ConnectionBuilder {
    pub settings: Settings,
}

Helps constructing a connection to the server.

Fields

settings: Settings

Implementations

impl ConnectionBuilder

pub fn heartbeat_delay(self, delay: Duration) -> Self

Maximum delay of inactivity before the client sends a heartbeat request.

pub fn heartbeat_timeout(self, timeout: Duration) -> Self

Maximum delay the server has to issue a heartbeat response.

pub fn operation_timeout(self, timeout: Duration) -> Self

Delay in which an operation will be retried if no response arrived.

pub fn operation_retry(self, strategy: Retry) -> Self

Retry strategy when an operation has timeout.

pub fn connection_retry(self, strategy: Retry) -> Self

Retry strategy when failing to connect.

pub fn with_default_user(self, user: Credentials) -> Self

'Credentials' to use if other Credentials are not explicitly supplied when issuing commands.

pub fn with_connection_name<S>(self, name: S) -> Self where
    S: AsRef<str>, 

Default connection name.

pub fn operation_check_period(self, period: Duration) -> Self

The period used to check pending command. Those checks include if the the connection has timeout or if the command was issued with a different connection.

pub fn connection_timeout(self, period: Duration) -> Self

Maximum delay to create a successful connection to a node.

pub fn socket_connection_timeout(self, period: Duration) -> Self

Maximum delay to physically connect to a node. This property differs from connection_timeout by referencing the delay to have a connected socket to a node, whereas connection_timeout refers to the whole connection, validation included.

pub fn enable_secure_connection(self, config: SecureSettings) -> Self

Enable secure connection with the server/cluster.

pub async fn single_node_connection(self, addr: SocketAddr) -> Connection

Creates a connection to a single EventStore node. The connection will start right away.

pub async fn cluster_nodes_through_gossip_connection(
    self,
    setts: GossipSeedClusterSettings
) -> Connection

Creates a connection to a cluster of EventStore nodes. The connection will start right away. Those GossipSeed should be the external HTTP endpoint of a node. The standard external HTTP endpoint is running on 2113.