Skip to content

Commit

Permalink
rename Endpoint::our_endpoint to Endpoint::our_addr
Browse files Browse the repository at this point in the history
  • Loading branch information
davidrusu committed Oct 29, 2020
1 parent ae2453e commit c1849af
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions src/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ impl QuicP2p {
/// config.port = Some(3000);
/// let mut quic_p2p = QuicP2p::with_config(Some(config.clone()), &[], true)?;
/// let endpoint = quic_p2p.new_endpoint()?;
/// let peer_addr = endpoint.our_endpoint()?;
/// let peer_addr = endpoint.our_addr()?;
///
/// config.port = Some(3001);
/// let mut quic_p2p = QuicP2p::with_config(Some(config), &[peer_addr], true)?;
Expand Down Expand Up @@ -268,7 +268,7 @@ impl QuicP2p {
/// config.ip = Some(IpAddr::V4(Ipv4Addr::LOCALHOST));
/// let mut quic_p2p = QuicP2p::with_config(Some(config.clone()), Default::default(), true)?;
/// let peer_1 = quic_p2p.new_endpoint()?;
/// let peer1_addr = peer_1.our_endpoint()?;
/// let peer1_addr = peer_1.our_addr()?;
///
/// let (peer_2, connection) = quic_p2p.connect_to(&peer1_addr).await?;
/// Ok(())
Expand Down
4 changes: 2 additions & 2 deletions src/connections.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ impl Connection {
/// config.ip = Some(IpAddr::V4(Ipv4Addr::LOCALHOST));
/// let mut quic_p2p = QuicP2p::with_config(Some(config.clone()), Default::default(), true)?;
/// let peer_1 = quic_p2p.new_endpoint()?;
/// let peer1_addr = peer_1.our_endpoint()?;
/// let peer1_addr = peer_1.our_addr()?;
///
/// let (peer_2, connection) = quic_p2p.connect_to(&peer1_addr).await?;
/// assert_eq!(connection.remote_address(), peer1_addr);
Expand All @@ -75,7 +75,7 @@ impl Connection {
/// config.ip = Some(IpAddr::V4(Ipv4Addr::LOCALHOST));
/// let mut quic_p2p = QuicP2p::with_config(Some(config.clone()), Default::default(), true)?;
/// let peer_1 = quic_p2p.new_endpoint()?;
/// let peer1_addr = peer_1.our_endpoint()?;
/// let peer1_addr = peer_1.our_addr()?;
///
/// let (peer_2, connection) = quic_p2p.connect_to(&peer1_addr).await?;
/// let (send_stream, recv_stream) = connection.open_bi_stream().await?;
Expand Down
4 changes: 2 additions & 2 deletions src/endpoint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,14 @@ impl Endpoint {
/// Note that if such an obtained address is of unspecified category we will ignore that as
/// such an address cannot be reached and hence not useful.
#[cfg(feature = "upnp")]
pub fn our_endpoint(&self) -> Result<SocketAddr> {
pub fn our_addr(&self) -> Result<SocketAddr> {
// TODO: make use of UPnP
self.local_addr()
}

/// Endpoint local address to give others for them to connect to us.
#[cfg(not(feature = "upnp"))]
pub fn our_endpoint(&self) -> Result<SocketAddr> {
pub fn our_addr(&self) -> Result<SocketAddr> {
self.local_addr()
}

Expand Down
10 changes: 5 additions & 5 deletions tests/quic_p2p.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ fn random_msg() -> Bytes {
async fn successful_connection() -> Result<()> {
let qp2p = new_qp2p();
let peer1 = qp2p.new_endpoint()?;
let peer1_addr = peer1.our_endpoint()?;
let peer1_addr = peer1.our_addr()?;

let peer2 = qp2p.new_endpoint()?;
let _connection = peer2.connect_to(&peer1_addr).await?;
Expand All @@ -45,7 +45,7 @@ async fn successful_connection() -> Result<()> {
.await
.ok_or_else(|| Error::Unexpected("No incoming connection".to_string()))?;

assert_eq!(incoming_messages.remote_addr(), peer2.our_endpoint()?);
assert_eq!(incoming_messages.remote_addr(), peer2.our_addr()?);

Ok(())
}
Expand All @@ -54,7 +54,7 @@ async fn successful_connection() -> Result<()> {
async fn bi_directional_streams() -> Result<()> {
let qp2p = new_qp2p();
let peer1 = qp2p.new_endpoint()?;
let peer1_addr = peer1.our_endpoint()?;
let peer1_addr = peer1.our_addr()?;

let peer2 = qp2p.new_endpoint()?;
let connection = peer2.connect_to(&peer1_addr).await?;
Expand Down Expand Up @@ -110,11 +110,11 @@ async fn bi_directional_streams() -> Result<()> {
async fn uni_directional_streams() -> Result<()> {
let qp2p = new_qp2p();
let peer1 = qp2p.new_endpoint()?;
let peer1_addr = peer1.our_endpoint()?;
let peer1_addr = peer1.our_addr()?;
let mut incoming_conn_peer1 = peer1.listen()?;

let peer2 = qp2p.new_endpoint()?;
let peer2_addr = peer2.our_endpoint()?;
let peer2_addr = peer2.our_addr()?;
let mut incoming_conn_peer2 = peer2.listen()?;

// Peer 2 sends a message
Expand Down

0 comments on commit c1849af

Please sign in to comment.