← Back to branch summary

~ubuntu-branches/debian/experimental/kopete/experimental

« back to all changes in this revision

Viewing changes to protocols/jabber/googletalk/libjingle/talk/base/bandwidthsmoother.h

  • Committer: Package Import Robot
  • Author(s): Maximiliano Curia
  • Date: 2015-02-24 11:32:57 UTC
  • mfrom: (1.1.41 vivid)
  • Revision ID: package-import@ubuntu.com-20150224113257-gnupg4v7lzz18ij0
Tags: 4:14.12.2-1
* New upstream release (14.12.2).
* Bump Standards-Version to 3.9.6, no changes needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
protocols/jabber/googletalk/libjingle/talk/base/bandwidthsmoother.h
1
 
/*
2
 
 * libjingle
3
 
 * Copyright 2011, Google Inc.
4
 
 *
5
 
 * Redistribution and use in source and binary forms, with or without
6
 
 * modification, are permitted provided that the following conditions are met:
7
 
 *
8
 
 *  1. Redistributions of source code must retain the above copyright notice,
9
 
 *     this list of conditions and the following disclaimer.
10
 
 *  2. Redistributions in binary form must reproduce the above copyright notice,
11
 
 *     this list of conditions and the following disclaimer in the documentation
12
 
 *     and/or other materials provided with the distribution.
13
 
 *  3. The name of the author may not be used to endorse or promote products
14
 
 *     derived from this software without specific prior written permission.
15
 
 *
16
 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17
 
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18
 
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19
 
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20
 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21
 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22
 
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23
 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24
 
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25
 
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
 
 */
27
 
 
28
 
#ifndef TALK_BASE_BANDWIDTHSMOOTHER_H_
29
 
#define TALK_BASE_BANDWIDTHSMOOTHER_H_
30
 
 
31
 
#include "talk/base/rollingaccumulator.h"
32
 
#include "talk/base/timeutils.h"
33
 
 
34
 
namespace talk_base {
35
 
 
36
 
// The purpose of BandwidthSmoother is to smooth out bandwidth
37
 
// estimations so that 'trstate' messages can be triggered when we
38
 
// are "sure" there is sufficient bandwidth.  To avoid frequent fluctuations,
39
 
// we take a slightly pessimistic view of our bandwidth.  We only increase
40
 
// our estimation when we have sampled bandwidth measurements of values
41
 
// at least as large as the current estimation * percent_increase
42
 
// for at least time_between_increase time.  If a sampled bandwidth
43
 
// is less than our current estimation we immediately decrease our estimation
44
 
// to that sampled value.
45
 
class BandwidthSmoother {
46
 
 public:
47
 
  BandwidthSmoother(int initial_bandwidth_guess,
48
 
                    uint32 time_between_increase,
49
 
                    double percent_increase,
50
 
                    size_t samples_count_to_average);
51
 
 
52
 
  // Samples a new bandwidth measurement.
53
 
  // bandwidth is expected to be non-negative.
54
 
  // returns true if the bandwidth estimation changed
55
 
  bool Sample(uint32 sample_time, int bandwidth);
56
 
 
57
 
  int get_bandwidth_estimation() const {
58
 
    return bandwidth_estimation_;
59
 
  }
60
 
 
61
 
 private:
62
 
  uint32 time_between_increase_;
63
 
  double percent_increase_;
64
 
  uint32 time_at_last_change_;
65
 
  int bandwidth_estimation_;
66
 
  RollingAccumulator<int> accumulator_;
67
 
};
68
 
 
69
 
}  // namespace talk_base
70
 
 
71
 
#endif  // TALK_BASE_BANDWIDTHSMOOTHER_H_