docs: Add more doc strings
This commit is contained in:
		
							parent
							
								
									a8d80eaddf
								
							
						
					
					
						commit
						b16c9f4b30
					
				@ -84,16 +84,21 @@ abstract class ReconnectionPolicy {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
/// A simple reconnection strategy: Make the reconnection delays exponentially longer
 | 
					/// A simple reconnection strategy: Make the reconnection delays exponentially longer
 | 
				
			||||||
/// for every failed attempt.
 | 
					/// for every failed attempt.
 | 
				
			||||||
 | 
					/// NOTE: This ReconnectionPolicy may be broken
 | 
				
			||||||
class ExponentialBackoffReconnectionPolicy extends ReconnectionPolicy {
 | 
					class ExponentialBackoffReconnectionPolicy extends ReconnectionPolicy {
 | 
				
			||||||
 | 
					  ExponentialBackoffReconnectionPolicy(this._maxBackoffTime) : super();
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  ExponentialBackoffReconnectionPolicy(this._maxBackoffTime)
 | 
					  /// The maximum time in seconds that a backoff step should be.
 | 
				
			||||||
  : _counter = 0,
 | 
					 | 
				
			||||||
    _log = Logger('ExponentialBackoffReconnectionPolicy'),
 | 
					 | 
				
			||||||
    super();
 | 
					 | 
				
			||||||
  final int _maxBackoffTime;
 | 
					  final int _maxBackoffTime;
 | 
				
			||||||
  int _counter;
 | 
					
 | 
				
			||||||
 | 
					  /// Amount of consecutive failed reconnections.
 | 
				
			||||||
 | 
					  int _counter = 0;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  /// Backoff timer.
 | 
				
			||||||
  Timer? _timer;
 | 
					  Timer? _timer;
 | 
				
			||||||
  final Logger _log;
 | 
					
 | 
				
			||||||
 | 
					  /// Logger.
 | 
				
			||||||
 | 
					  final Logger _log = Logger('ExponentialBackoffReconnectionPolicy');
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  /// Called when the backoff expired
 | 
					  /// Called when the backoff expired
 | 
				
			||||||
  Future<void> _onTimerElapsed() async {
 | 
					  Future<void> _onTimerElapsed() async {
 | 
				
			||||||
@ -141,7 +146,7 @@ class ExponentialBackoffReconnectionPolicy extends ReconnectionPolicy {
 | 
				
			|||||||
  }
 | 
					  }
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/// A stub reconnection policy for tests
 | 
					/// A stub reconnection policy for tests.
 | 
				
			||||||
@visibleForTesting
 | 
					@visibleForTesting
 | 
				
			||||||
class TestingReconnectionPolicy extends ReconnectionPolicy {
 | 
					class TestingReconnectionPolicy extends ReconnectionPolicy {
 | 
				
			||||||
  TestingReconnectionPolicy() : super();
 | 
					  TestingReconnectionPolicy() : super();
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
		Reference in New Issue
	
	Block a user