Rename "announced ip" to "announced address"

CHANGELOG.md

@@ -3,7 +3,8 @@
 ### NEXT
 
 - Make transport-cc feedback work similarly to libwebrtc ([PR #1088](https://github.com/versatica/mediasoup/pull/1088) by @penguinol).
-- `TransportListenInfo`: announced ip can also be a hostname ([PR #1322](https://github.com/versatica/mediasoup/pull/1322)).
+- `TransportListenInfo`: "announced ip" can also be a hostname ([PR #1322](https://github.com/versatica/mediasoup/pull/1322)).
+- `TransportListenInfo`: Rename "announced ip" to "announced address" ([PR #1323](https://github.com/versatica/mediasoup/pull/1323)).
 
 ### 3.13.17
 

node/src/Router.ts

@@ -867,7 +867,7 @@ export class Router<
 			listenInfo = {
 				protocol: 'udp',
 				ip: listenIp.ip,
-				announcedIp: listenIp.announcedIp,
+				announcedAddress: listenIp.announcedIp,
 				port: port,
 			};
 		}
@@ -896,7 +896,7 @@ export class Router<
 					? FbsTransportProtocol.UDP
 					: FbsTransportProtocol.TCP,
 				listenInfo!.ip,
-				listenInfo!.announcedIp,
+				listenInfo!.announcedAddress,
 				listenInfo!.port,
 				socketFlagsToFbs(listenInfo!.flags),
 				listenInfo!.sendBufferSize,
@@ -1162,12 +1162,12 @@ export class Router<
 					.then(() => {
 						return Promise.all([
 							localPipeTransport.connect({
-								ip: remotePipeTransport.tuple.localIp,
+								ip: remotePipeTransport.tuple.localAddress,
 								port: remotePipeTransport.tuple.localPort,
 								srtpParameters: remotePipeTransport.srtpParameters,
 							}),
 							remotePipeTransport.connect({
-								ip: localPipeTransport.tuple.localIp,
+								ip: localPipeTransport.tuple.localAddress,
 								port: localPipeTransport.tuple.localPort,
 								srtpParameters: localPipeTransport.srtpParameters,
 							}),

node/src/Transport.ts

@@ -72,11 +72,19 @@ export type TransportListenInfo = {
 	ip: string;
 
 	/**
+	 * @deprecated Use |announcedAddress| instead.
+	 *
 	 * Announced IPv4, IPv6 or hostname (useful when running mediasoup behind NAT
 	 * with private IP).
 	 */
 	announcedIp?: string;
 
+	/**
+	 * Announced IPv4, IPv6 or hostname (useful when running mediasoup behind NAT
+	 * with private IP).
+	 */
+	announcedAddress?: string;
+
 	/**
 	 * Listening port.
 	 */
@@ -136,7 +144,9 @@ export type TransportSocketFlags = {
 };
 
 export type TransportTuple = {
+	// @deprecated Use localAddress instead.
 	localIp: string;
+	localAddress: string;
 	localPort: number;
 	remoteIp?: string;
 	remotePort?: number;
@@ -1354,7 +1364,9 @@ export function serializeProtocol(
 
 export function parseTuple(binary: FbsTransport.Tuple): TransportTuple {
 	return {
-		localIp: binary.localIp()!,
+		// @deprecated Use localAddress instead.
+		localIp: binary.localAddress()!,
+		localAddress: binary.localAddress()!,
 		localPort: binary.localPort(),
 		remoteIp: binary.remoteIp() ?? undefined,
 		remotePort: binary.remotePort(),

node/src/WebRtcTransport.ts

@@ -138,7 +138,9 @@ export type IceParameters = {
 export type IceCandidate = {
 	foundation: string;
 	priority: number;
+	// @deprecated Use |address| instead.
 	ip: string;
+	address: string;
 	protocol: TransportProtocol;
 	port: number;
 	type: IceCandidateType;
@@ -864,7 +866,8 @@ function parseIceCandidate(
 	return {
 		foundation: binary.foundation()!,
 		priority: binary.priority(),
-		ip: binary.ip()!,
+		ip: binary.address()!,
+		address: binary.address()!,
 		protocol: parseProtocol(binary.protocol()),
 		port: binary.port(),
 		type: iceCandidateTypeFromFbs(binary.type()),

node/src/test/test-PlainTransport.ts

@@ -84,7 +84,9 @@ test('router.createPlainTransport() succeeds', async () => {
 	expect(plainTransport2.closed).toBe(false);
 	expect(plainTransport2.appData).toEqual({ foo: 'bar' });
 	expect(typeof plainTransport2.tuple).toBe('object');
+	// @deprecated Use tuple.localAddress instead.
 	expect(plainTransport2.tuple.localIp).toBe('9.9.9.1');
+	expect(plainTransport2.tuple.localAddress).toBe('9.9.9.1');
 	expect(typeof plainTransport2.tuple.localPort).toBe('number');
 	expect(plainTransport2.tuple.protocol).toBe('udp');
 	expect(plainTransport2.rtcpTuple).toBeUndefined();
@@ -138,11 +140,15 @@ test('router.createPlainTransport() succeeds', async () => {
 	expect(transport2.closed).toBe(false);
 	expect(transport2.appData).toEqual({});
 	expect(typeof transport2.tuple).toBe('object');
+	// @deprecated Use tuple.localAddress instead.
 	expect(transport2.tuple.localIp).toBe('127.0.0.1');
+	expect(transport2.tuple.localAddress).toBe('127.0.0.1');
 	expect(transport2.tuple.localPort).toBe(rtpPort);
 	expect(transport2.tuple.protocol).toBe('udp');
 	expect(typeof transport2.rtcpTuple).toBe('object');
+	// @deprecated Use tuple.localAddress instead.
 	expect(transport2.rtcpTuple?.localIp).toBe('127.0.0.1');
+	expect(transport2.rtcpTuple?.localAddress).toBe('127.0.0.1');
 	expect(transport2.rtcpTuple?.localPort).toBe(rtcpPort);
 	expect(transport2.rtcpTuple?.protocol).toBe('udp');
 	expect(transport2.sctpParameters).toBeUndefined();
@@ -395,7 +401,9 @@ test('plainTransport.getStats() succeeds', async () => {
 	expect(stats[0].probationBytesSent).toBe(0);
 	expect(stats[0].probationSendBitrate).toBe(0);
 	expect(typeof stats[0].tuple).toBe('object');
+	// @deprecated Use tuple.localAddress instead.
 	expect(stats[0].tuple.localIp).toBe('127.0.0.1');
+	expect(stats[0].tuple.localAddress).toBe('127.0.0.1');
 	expect(typeof stats[0].tuple.localPort).toBe('number');
 	expect(stats[0].tuple.protocol).toBe('udp');
 	expect(stats[0].rtcpTuple).toBeUndefined();

node/src/test/test-WebRtcTransport.ts

@@ -541,7 +541,9 @@ test('WebRtcTransport events succeed', async () => {
 
 	const onIceSelectedTuple = jest.fn();
 	const iceSelectedTuple: TransportTuple = {
+		// @deprecated Use localAddress.
 		localIp: '1.1.1.1',
+		localAddress: '1.1.1.1',
 		localPort: 1111,
 		remoteIp: '2.2.2.2',
 		remotePort: 2222,
@@ -554,7 +556,7 @@ test('WebRtcTransport events succeed', async () => {
 	const iceSelectedTupleChangeNotification =
 		new FbsWebRtcTransport.IceSelectedTupleChangeNotificationT(
 			new FbsTransport.TupleT(
-				iceSelectedTuple.localIp,
+				iceSelectedTuple.localAddress,
 				iceSelectedTuple.localPort,
 				iceSelectedTuple.remoteIp,
 				iceSelectedTuple.remotePort,

node/src/test/test-node-sctp.ts

@@ -39,7 +39,7 @@ beforeEach(async () => {
 		ctx.udpSocket!.bind(0, '127.0.0.1', resolve);
 	});
 
-	const remoteUdpIp = ctx.plainTransport.tuple.localIp;
+	const remoteUdpIp = ctx.plainTransport.tuple.localAddress;
 	const remoteUdpPort = ctx.plainTransport.tuple.localPort;
 	const { OS, MIS } = ctx.plainTransport.sctpParameters!;
 

rust/benches/producer.rs

@@ -65,7 +65,7 @@ async fn init() -> (Worker, Router, WebRtcTransport, WebRtcTransport) {
         WebRtcTransportOptions::new(WebRtcTransportListenInfos::new(ListenInfo {
             protocol: Protocol::Udp,
             ip: IpAddr::V4(Ipv4Addr::LOCALHOST),
-            announced_ip: None,
+            announced_address: None,
             port: None,
             flags: None,
             send_buffer_size: None,

rust/examples/echo.rs

@@ -185,7 +185,7 @@ impl EchoConnection {
             WebRtcTransportOptions::new(WebRtcTransportListenInfos::new(ListenInfo {
                 protocol: Protocol::Udp,
                 ip: IpAddr::V4(Ipv4Addr::LOCALHOST),
-                announced_ip: None,
+                announced_address: None,
                 port: None,
                 flags: None,
                 send_buffer_size: None,

rust/examples/multiopus.rs

@@ -148,7 +148,7 @@ impl EchoConnection {
                 let mut options = PlainTransportOptions::new(ListenInfo {
                     protocol: Protocol::Udp,
                     ip: IpAddr::V4(Ipv4Addr::LOCALHOST),
-                    announced_ip: None,
+                    announced_address: None,
                     port: None,
                     flags: None,
                     send_buffer_size: None,
@@ -198,9 +198,9 @@ impl EchoConnection {
             RTCP listening on {}:{}\n  \
             PT=100\n  \
             SSRC=1111",
-            plain_transport.tuple().local_ip(),
+            plain_transport.tuple().local_address(),
             plain_transport.tuple().local_port(),
-            plain_transport.rtcp_tuple().unwrap().local_ip(),
+            plain_transport.rtcp_tuple().unwrap().local_address(),
             plain_transport.rtcp_tuple().unwrap().local_port(),
         );
 
@@ -220,9 +220,9 @@ impl EchoConnection {
                 rtpbin.send_rtp_sink_0 \\\n  \
                 rtpbin.send_rtp_src_0 ! udpsink host={} port={} sync=false async=false \\\n  \
                 rtpbin.send_rtcp_src_0 ! udpsink host={} port={} sync=false async=false",
-                plain_transport.tuple().local_ip(),
+                plain_transport.tuple().local_address(),
                 plain_transport.tuple().local_port(),
-                plain_transport.rtcp_tuple().unwrap().local_ip(),
+                plain_transport.rtcp_tuple().unwrap().local_address(),
                 plain_transport.rtcp_tuple().unwrap().local_port(),
         );
 
@@ -234,7 +234,7 @@ impl EchoConnection {
                 WebRtcTransportListenInfos::new(ListenInfo {
                     protocol: Protocol::Udp,
                     ip: IpAddr::V4(Ipv4Addr::LOCALHOST),
-                    announced_ip: None,
+                    announced_address: None,
                     port: None,
                     flags: None,
                     send_buffer_size: None,

rust/examples/svc-simulcast.rs

@@ -205,7 +205,7 @@ impl SvcSimulcastConnection {
             WebRtcTransportOptions::new(WebRtcTransportListenInfos::new(ListenInfo {
                 protocol: Protocol::Udp,
                 ip: IpAddr::V4(Ipv4Addr::LOCALHOST),
-                announced_ip: None,
+                announced_address: None,
                 port: None,
                 flags: None,
                 send_buffer_size: None,

rust/examples/videoroom.rs

@@ -499,7 +499,7 @@ mod participant {
                 WebRtcTransportOptions::new(WebRtcTransportListenInfos::new(ListenInfo {
                     protocol: Protocol::Udp,
                     ip: IpAddr::V4(Ipv4Addr::LOCALHOST),
-                    announced_ip: None,
+                    announced_address: None,
                     port: None,
                     flags: None,
                     send_buffer_size: None,

rust/src/data_structures.rs

@@ -50,7 +50,8 @@ impl AppData {
 /// Listening protocol, IP and port for [`WebRtcServer`](crate::webrtc_server::WebRtcServer) to listen on.
 ///
 /// # Notes on usage
-/// If you use "0.0.0.0" or "::" as ip value, then you need to also provide `announced_ip`.
+/// If you use "0.0.0.0" or "::" as ip value, then you need to also provide
+/// `announced_address`.
 #[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Deserialize, Serialize)]
 #[serde(rename_all = "camelCase")]
 pub struct ListenInfo {
@@ -61,7 +62,7 @@ pub struct ListenInfo {
     /// Announced IPv4, IPv6 or hostname (useful when running mediasoup behind
     /// NAT with private IP).
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub announced_ip: Option<String>,
+    pub announced_address: Option<String>,
     /// Listening port.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub port: Option<u16>,
@@ -84,7 +85,10 @@ impl ListenInfo {
                 Protocol::Udp => transport::Protocol::Udp,
             },
             ip: self.ip.to_string(),
-            announced_ip: self.announced_ip.clone().map(|ip| ip.to_string()),
+            announced_address: self
+                .announced_address
+                .clone()
+                .map(|address| address.to_string()),
             port: self.port.unwrap_or(0),
             flags: Box::new(self.flags.unwrap_or_default().to_fbs()),
             send_buffer_size: self.send_buffer_size.unwrap_or(0),
@@ -231,7 +235,7 @@ pub struct IceCandidate {
     /// The assigned priority of the candidate.
     pub priority: u32,
     /// The IP address or hostname of the candidate.
-    pub ip: String,
+    pub address: String,
     /// The protocol of the candidate.
     pub protocol: Protocol,
     /// The port for the candidate.
@@ -248,7 +252,7 @@ impl IceCandidate {
         Self {
             foundation: candidate.foundation.clone(),
             priority: candidate.priority,
-            ip: candidate.ip.clone(),
+            address: candidate.address.clone(),
             protocol: Protocol::from_fbs(candidate.protocol),
             port: candidate.port,
             r#type: IceCandidateType::from_fbs(candidate.type_),
@@ -293,14 +297,14 @@ impl IceState {
 /// `PipeTransport`, or via dynamic detection as it happens in `WebRtcTransport` (in which the
 /// remote media address is detected by ICE means), or in `PlainTransport` (when using `comedia`
 /// mode).
-#[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Deserialize, Serialize)]
+#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Deserialize, Serialize)]
 #[serde(untagged)]
 pub enum TransportTuple {
     /// Transport tuple with remote endpoint info.
     #[serde(rename_all = "camelCase")]
     WithRemote {
-        /// Local IP address.
-        local_ip: IpAddr,
+        /// Local IP address or hostname.
+        local_address: String,
         /// Local port.
         local_port: u16,
         /// Remote IP address.
@@ -313,8 +317,8 @@ pub enum TransportTuple {
     /// Transport tuple without remote endpoint info.
     #[serde(rename_all = "camelCase")]
     LocalOnly {
-        /// Local IP address.
-        local_ip: IpAddr,
+        /// Local IP address or hostname.
+        local_address: String,
         /// Local port.
         local_port: u16,
         /// Protocol
@@ -323,10 +327,10 @@ pub enum TransportTuple {
 }
 
 impl TransportTuple {
-    /// Local IP address.
-    pub fn local_ip(&self) -> IpAddr {
-        let (Self::WithRemote { local_ip, .. } | Self::LocalOnly { local_ip, .. }) = self;
-        *local_ip
+    /// Local IP address or hostname.
+    pub fn local_address(&self) -> &String {
+        let (Self::WithRemote { local_address, .. } | Self::LocalOnly { local_address, .. }) = self;
+        local_address
     }
 
     /// Local port.
@@ -362,19 +366,25 @@ impl TransportTuple {
     pub(crate) fn from_fbs(tuple: &transport::Tuple) -> TransportTuple {
         match &tuple.remote_ip {
             Some(_remote_ip) => TransportTuple::WithRemote {
-                local_ip: tuple.local_ip.parse().expect("Error parsing IP address"),
+                local_address: tuple
+                    .local_address
+                    .parse()
+                    .expect("Error parsing local address"),
                 local_port: tuple.local_port,
                 remote_ip: tuple
                     .remote_ip
                     .as_ref()
                     .unwrap()
                     .parse()
-                    .expect("Error parsing IP address"),
+                    .expect("Error parsing remote IP address"),
                 remote_port: tuple.remote_port,
                 protocol: Protocol::from_fbs(tuple.protocol),
             },
             None => TransportTuple::LocalOnly {
-                local_ip: tuple.local_ip.parse().expect("Error parsing IP address"),
+                local_address: tuple
+                    .local_address
+                    .parse()
+                    .expect("Error parsing local address"),
                 local_port: tuple.local_port,
                 protocol: Protocol::from_fbs(tuple.protocol),
             },