Struct BasicPeer 

pub struct BasicPeer {
    pub _address: SocketAddr,
    pub sni: String,
    pub options: PeerOptions,
}

A simple TCP or TLS peer without many complicated settings.

Fields

_address: SocketAddr

sni: String

options: PeerOptions

Implementations

impl BasicPeer

pub fn new(address: &str) -> Self

Create a new BasicPeer.

pub fn new_uds<P: AsRef<Path>>(path: P) -> Result<Self>

Available on Unix only.

Create a new BasicPeer with the given path to a Unix domain socket.

Trait Implementations

impl Clone for BasicPeer

fn clone(&self) -> BasicPeer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasicPeer

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

Formats the value using the given formatter.

impl Display for BasicPeer

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

Formats the value using the given formatter.

impl Peer for BasicPeer

fn address(&self) -> &SocketAddr

The remote address to connect to

fn tls(&self) -> bool

If TLS should be used;

fn bind_to(&self) -> Option<&BindTo>

Information about the local source address this connection should be bound to.

fn sni(&self) -> &str

The SNI to send, if TLS is used

fn reuse_hash(&self) -> u64

To decide whether a Peer can use the connection established by another Peer.

fn get_peer_options(&self) -> Option<&PeerOptions>

Get the additional options to connect to the peer.

fn get_proxy(&self) -> Option<&Proxy>

Get the proxy setting to connect to the remote server

fn get_mut_peer_options(&mut self) -> Option<&mut PeerOptions>

Get the additional options for modification.

fn verify_cert(&self) -> bool

Whether the TLS handshake should validate the cert of the server.

fn verify_hostname(&self) -> bool

Whether the TLS handshake should verify that the server cert matches the SNI.

fn alternative_cn(&self) -> Option<&String>

The alternative common name to use to verify the server cert.

fn connection_timeout(&self) -> Option<Duration>

How long connect() call should be wait before it returns a timeout error.

fn total_connection_timeout(&self) -> Option<Duration>

How long the overall connection establishment should take before a timeout error is returned.

fn idle_timeout(&self) -> Option<Duration>

If the connection can be reused, how long the connection should wait to be reused before it shuts down.

fn get_alpn(&self) -> Option<&ALPN>

Get the ALPN preference.

fn get_ca(&self) -> Option<&Arc<CaType>>

Get the CA cert to use to validate the server cert.

fn get_client_cert_key(&self) -> Option<&Arc<CertKey>>

Get the client cert and key for mutual TLS if any

fn tcp_keepalive(&self) -> Option<&TcpKeepalive>

The TCP keepalive setting that should be applied to this connection

fn h2_ping_interval(&self) -> Option<Duration>

The interval H2 pings to send to the server if any

fn tcp_recv_buf(&self) -> Option<usize>

The size of the TCP receive buffer should be limited to. See SO_RCVBUF for more details.

fn dscp(&self) -> Option<u8>

The DSCP value that should be applied to the send side of this connection. See the RFC for more details.

fn tcp_fast_open(&self) -> bool

Whether to enable TCP fast open.

fn matches_fd<V: AsRawFd>(&self, fd: V) -> bool

Available on Unix only.

fn get_tracer(&self) -> Option<Tracer>

fn upstream_tcp_sock_tweak_hook( &self, ) -> Option<&Arc<dyn Fn(&TcpSocket) -> Result<()> + Send + Sync + 'static>>

Returns a hook that should be run before an upstream TCP connection is connected.

fn proxy_digest_user_data_hook(&self) -> Option<&ProxyDigestUserDataHook>

Returns a ProxyDigestUserDataHook that may generate user data for crate::protocols::raw_connect::ProxyDigest when establishing a new proxy connection.