aboutsummaryrefslogtreecommitdiff
path: root/net/src/connection.rs
blob: 53bcdeb3681aae917e6a50d08a625fac1d081551 (plain)
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
use crate::{Endpoint, Result};
use async_trait::async_trait;

use crate::transports::{tcp, udp, unix};

/// Alias for `Box<dyn Connection>`
pub type Conn = Box<dyn Connection>;

/// Connection is a generic network connection interface for
/// `UdpConn`, `TcpConn`, and `UnixConn`.
///
/// If you are familiar with the Go language, this is similar to the `Conn`
/// interface <https://pkg.go.dev/net#Conn>
#[async_trait]
pub trait Connection: Send + Sync {
    /// Returns the remote peer endpoint of this connection
    fn peer_endpoint(&self) -> Result<Endpoint>;

    /// Returns the local socket endpoint of this connection
    fn local_endpoint(&self) -> Result<Endpoint>;

    /// Reads data from this connection.  
    async fn read(&self, buf: &mut [u8]) -> Result<usize>;

    /// Writes data to this connection
    async fn write(&self, buf: &[u8]) -> Result<usize>;
}

/// Connects to the provided endpoint.
///
/// it only supports `tcp4/6`, `udp4/6` and `unix`.
///
/// #Example
///
/// ```
/// use karyons_net::{Endpoint, dial};
///
/// async {
///     let endpoint: Endpoint = "tcp://127.0.0.1:3000".parse().unwrap();
///
///     let conn = dial(&endpoint).await.unwrap();
///
///     conn.write(b"MSG").await.unwrap();
///
///     let mut buffer = [0;32];
///     conn.read(&mut buffer).await.unwrap();
/// };
///
/// ```
///
pub async fn dial(endpoint: &Endpoint) -> Result<Conn> {
    match endpoint {
        Endpoint::Tcp(addr, port) => Ok(Box::new(tcp::dial_tcp(addr, port).await?)),
        Endpoint::Udp(addr, port) => Ok(Box::new(udp::dial_udp(addr, port).await?)),
        Endpoint::Unix(addr) => Ok(Box::new(unix::dial_unix(addr).await?)),
    }
}