123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 |
- #if !BESTHTTP_DISABLE_SOCKETIO
- using System;
- using System.Text;
- using PlatformSupport.Collections.ObjectModel;
- #if !NETFX_CORE
- using PlatformSupport.Collections.Specialized;
- #else
- using System.Collections.Specialized;
- #endif
- namespace BestHTTP.SocketIO
- {
- public sealed class SocketOptions
- {
- #region Properties
- /// <summary>
- /// The SocketManager will try to connect with this transport.
- /// </summary>
- public Transports.TransportTypes ConnectWith { get; set; }
- /// <summary>
- /// Whether to reconnect automatically after a disconnect (default true)
- /// </summary>
- public bool Reconnection { get; set; }
- /// <summary>
- /// Number of attempts before giving up (default Int.MaxValue)
- /// </summary>
- public int ReconnectionAttempts { get; set; }
- /// <summary>
- /// How long to initially wait before attempting a new reconnection (default 1000ms).
- /// Affected by +/- RandomizationFactor, for example the default initial delay will be between 500ms to 1500ms.
- /// </summary>
- public TimeSpan ReconnectionDelay { get; set; }
- /// <summary>
- /// Maximum amount of time to wait between reconnections (default 5000ms).
- /// Each attempt increases the reconnection delay along with a randomization as above.
- /// </summary>
- public TimeSpan ReconnectionDelayMax { get; set; }
- /// <summary>
- /// (default 0.5`), [0..1]
- /// </summary>
- public float RandomizationFactor { get { return randomizationFactor; } set { randomizationFactor = Math.Min(1.0f, Math.Max(0.0f, value)); } }
- private float randomizationFactor;
- /// <summary>
- /// Connection timeout before a connect_error and connect_timeout events are emitted (default 20000ms)
- /// </summary>
- public TimeSpan Timeout { get; set; }
- /// <summary>
- /// By setting this false, you have to call SocketManager's Open() whenever you decide it's appropriate.
- /// </summary>
- public bool AutoConnect { get; set; }
- /// <summary>
- /// Additional query parameters that will be passed for the handshake uri. If the value is null, or an empty string it will be not appended to the query only the key.
- /// <remarks>The keys and values must be escaped properly, as the plugin will not escape these. </remarks>
- /// </summary>
- public ObservableDictionary<string, string> AdditionalQueryParams
- {
- get { return additionalQueryParams; }
- set
- {
- // Unsubscribe from previous dictionary's events
- if (additionalQueryParams != null)
- additionalQueryParams.CollectionChanged -= AdditionalQueryParams_CollectionChanged;
- additionalQueryParams = value;
- // Clear out the cached value
- BuiltQueryParams = null;
- // Subscribe to the collection changed event
- if (value != null)
- value.CollectionChanged += AdditionalQueryParams_CollectionChanged;
- }
- }
- private ObservableDictionary<string, string> additionalQueryParams;
- /// <summary>
- /// If it's false, the parameters in the AdditionalQueryParams will be passed for all HTTP requests. Its default value is true.
- /// </summary>
- public bool QueryParamsOnlyForHandshake { get; set; }
- #endregion
- /// <summary>
- /// The cached value of the result of the BuildQueryParams() call.
- /// </summary>
- private string BuiltQueryParams;
- /// <summary>
- /// Constructor, setting the default option values.
- /// </summary>
- public SocketOptions()
- {
- ConnectWith = Transports.TransportTypes.Polling;
- Reconnection = true;
- ReconnectionAttempts = int.MaxValue;
- ReconnectionDelay = TimeSpan.FromMilliseconds(1000);
- ReconnectionDelayMax = TimeSpan.FromMilliseconds(5000);
- RandomizationFactor = 0.5f;
- Timeout = TimeSpan.FromMilliseconds(20000);
- AutoConnect = true;
- QueryParamsOnlyForHandshake = true;
- }
- #region Helper Functions
- /// <summary>
- /// Builds the keys and values from the AdditionalQueryParams to an key=value form. If AdditionalQueryParams is null or empty, it will return an empty string.
- /// </summary>
- internal string BuildQueryParams()
- {
- if (AdditionalQueryParams == null || AdditionalQueryParams.Count == 0)
- return string.Empty;
- if (!string.IsNullOrEmpty(BuiltQueryParams))
- return BuiltQueryParams;
- StringBuilder sb = new StringBuilder(AdditionalQueryParams.Count * 4);
- foreach(var kvp in AdditionalQueryParams)
- {
- sb.Append("&");
- sb.Append(kvp.Key);
- if (!string.IsNullOrEmpty(kvp.Value))
- {
- sb.Append("=");
- sb.Append(kvp.Value);
- }
- }
- return BuiltQueryParams = sb.ToString();
- }
- /// <summary>
- /// This event will be called when the AdditonalQueryPrams dictionary changed. We have to reset the cached values.
- /// </summary>
- private void AdditionalQueryParams_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
- {
- BuiltQueryParams = null;
- }
- #endregion
- }
- }
- #endif
|