Struct ApiEndpoint 

pub struct ApiEndpoint {
    pub url: String,
    pub connect_timeout: Duration,
    pub keepalive_interval: Duration,
    pub keepalive_timeout: Duration,
}

Where and how to connect: the address and the timeouts of the channel.

Examples

use std::time::Duration;
use brokapi_finam_protocol::{ApiEndpoint, DEFAULT_ENDPOINT};

// Production: the default.
assert_eq!(ApiEndpoint::default().url, DEFAULT_ENDPOINT);

// A proxy or a local imitation: plain `http://`, a shorter connect timeout.
let mut ep = ApiEndpoint::new("http://127.0.0.1:50051");
ep.connect_timeout = Duration::from_secs(2);
assert_eq!(ep.keepalive_interval, Duration::from_secs(30));

Fields

url: String

https://host:port (TLS, webpki roots) or http://host:port (plaintext, tests/proxies).

connect_timeout: Duration

How long to wait for the TCP and TLS handshake. Default 10 seconds.

keepalive_interval: Duration

HTTP/2 PING interval, detects dead connections under long-lived streams. Default 30 seconds.

Pings are also sent while the channel is idle.

keepalive_timeout: Duration

How long to wait for the answer to a PING before the connection is declared dead. Default 10 seconds.

Implementations

impl ApiEndpoint

pub fn new(url: impl Into<String>) -> Self

Endpoint for url with the default timeouts (connect 10 s, keepalive 30 s and 10 s).

The URL is not checked here. A bad URL is reported by connect_lazy as FinamError::Config.

Trait Implementations

impl Clone for ApiEndpoint

fn clone(&self) -> ApiEndpoint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiEndpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApiEndpoint

fn default() -> Self

Returns the “default value” for a type.