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
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use std::{io, net::SocketAddr};

/// TCP listener for a GRPC service, always binds to the local IPv6 address
pub struct TcpListener {
    inner: std::net::TcpListener,
}

impl TcpListener {
    /// Binds a TCP listener, if `None` is passed, binds to an ephemeral port
    #[inline]
    pub fn bind(port: Option<u16>) -> io::Result<Self> {
        std::net::TcpListener::bind((std::net::Ipv6Addr::UNSPECIFIED, port.unwrap_or_default()))
            .map(|inner| Self { inner })
    }

    /// Retrieves the port the listener is bound to
    #[inline]
    pub fn port(&self) -> u16 {
        self.inner.local_addr().expect("failed to bind").port()
    }

    /// Retrieves the local address the listener is bound to
    #[inline]
    pub fn local_addr(&self) -> SocketAddr {
        self.inner.local_addr().expect("failed to bind")
    }

    #[inline]
    pub fn into_stream(self) -> io::Result<tokio_stream::wrappers::TcpListenerStream> {
        self.inner.set_nonblocking(true)?;
        let tl = tokio::net::TcpListener::from_std(self.inner)?;
        Ok(tokio_stream::wrappers::TcpListenerStream::new(tl))
    }
}

impl From<TcpListener> for std::net::TcpListener {
    #[inline]
    fn from(value: TcpListener) -> Self {
        value.inner
    }
}