Exposed 'iceTransportPolicy' UaSettings to allow for restricting acce…

…ptable ice candidates

lib/src/sip_ua_helper.dart

@@ -2,11 +2,11 @@ import 'dart:async';
 
 import 'package:flutter_webrtc/flutter_webrtc.dart';
 import 'package:logger/logger.dart';
-
 import 'package:sip_ua/sip_ua.dart';
 import 'package:sip_ua/src/map_helper.dart';
 import 'package:sip_ua/src/transports/socket_interface.dart';
 import 'package:sip_ua/src/transports/tcp_socket.dart';
+
 import 'config.dart';
 import 'constants.dart' as DartSIP_C;
 import 'event_manager/event_manager.dart';
@@ -331,6 +331,9 @@ class SIPUAHelper extends EventManager {
       'extraHeaders': <dynamic>[],
       'pcConfig': <String, dynamic>{
         'sdpSemantics': 'unified-plan',
+        'iceTransportPolicy':
+            (_uaSettings?.iceTransportPolicy ?? IceTransportPolicy.ALL)
+                .toParameterString(),
         'iceServers': _uaSettings?.iceServers
       },
       'mediaConstraints': <String, dynamic>{
@@ -468,11 +471,14 @@ enum CallStateEnum {
 
 class Call {
   Call(this._id, this._session, this.state);
+
   final String? _id;
   final RTCSession _session;
 
   String? get id => _id;
+
   RTCPeerConnection? get peerConnection => _session.connection;
+
   RTCSession get session => _session;
   CallStateEnum state;
 
@@ -626,6 +632,7 @@ class CallState {
       this.stream,
       this.cause,
       this.refer});
+
   CallStateEnum state;
   ErrorCause? cause;
   String? originator;
@@ -644,6 +651,7 @@ enum RegistrationStateEnum {
 
 class RegistrationState {
   RegistrationState({this.state, this.cause});
+
   RegistrationStateEnum? state;
   ErrorCause? cause;
 }
@@ -657,28 +665,35 @@ enum TransportStateEnum {
 
 class TransportState {
   TransportState(this.state, {this.cause});
+
   TransportStateEnum state;
   ErrorCause? cause;
 }
 
 class SIPMessageRequest {
   SIPMessageRequest(this.message, this.originator, this.request);
+
   dynamic request;
   String? originator;
   Message? message;
 }
 
 abstract class SipUaHelperListener {
   void transportStateChanged(TransportState state);
+
   void registrationStateChanged(RegistrationState state);
+
   void callStateChanged(Call call, CallState state);
+
   //For SIP message coming
   void onNewMessage(SIPMessageRequest msg);
+
   void onNewNotify(Notify ntf);
 }
 
 class Notify {
   Notify({this.request});
+
   IncomingRequest? request;
 }
 
@@ -724,6 +739,31 @@ enum DtmfMode {
   RFC2833,
 }
 
+/// Possible values for the transport policy to be used when selecting ICE
+/// candidates.
+///
+/// See: https://udn.realityripple.com/docs/Web/API/RTCConfiguration
+enum IceTransportPolicy {
+  /// All ICE candidates will be considered.
+  /// This is the default if not specified explicitly.
+  ALL,
+
+  /// Only ICE candidates whose IP addresses are being relayed, such as those
+  /// being passed through a TURN server, will be considered.
+  RELAY,
+}
+
+extension _IceTransportPolicyEncoding on IceTransportPolicy {
+  String toParameterString() {
+    switch (this) {
+      case IceTransportPolicy.ALL:
+        return 'all';
+      case IceTransportPolicy.RELAY:
+        return 'relay';
+    }
+  }
+}
+
 class UaSettings {
   WebSocketSettings webSocketSettings = WebSocketSettings();
   TcpSocketSettings tcpSocketSettings = TcpSocketSettings();
@@ -776,6 +816,11 @@ class UaSettings {
 //    },
   ];
 
+  /// Defines the transport policy to be used for ICE.
+  /// See [IceTransportPolicy] for possible values.
+  /// Will default to [IceTransportPolicy.ALL] if not specified.
+  IceTransportPolicy? iceTransportPolicy;
+
   /// Controls which kind of messages are to be sent to keep a SIP session
   /// alive.
   /// Defaults to "UPDATE"