15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_URL_REQUEST_URL_REQUEST_THROTTLER_ENTRY_INTERFACE_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_URL_REQUEST_URL_REQUEST_THROTTLER_ENTRY_INTERFACE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 12eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/time/time.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class URLRequest; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class URLRequestThrottlerHeaderInterface; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Interface provided on entries of the URL request throttler manager. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT URLRequestThrottlerEntryInterface 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : public base::RefCountedThreadSafe<URLRequestThrottlerEntryInterface> { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) URLRequestThrottlerEntryInterface() {} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true when we have encountered server errors and are doing 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // exponential back-off, unless the request has load flags that mean 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it is likely to be user-initiated, or the NetworkDelegate returns 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // false for |CanThrottleRequest(request)|. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // URLRequestHttpJob checks this method prior to every request; it 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // cancels requests if this method returns true. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool ShouldRejectRequest(const URLRequest& request) const = 0; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Calculates a recommended sending time for the next request and reserves it. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The sending time is not earlier than the current exponential back-off 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // release time or |earliest_time|. Moreover, the previous results of 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the method are taken into account, in order to make sure they are spread 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // properly over time. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the recommended delay before sending the next request, in 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // milliseconds. The return value is always positive or 0. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Although it is not mandatory, respecting the value returned by this method 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is helpful to avoid traffic overload. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int64 ReserveSendingTimeForNextRequest( 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::TimeTicks& earliest_time) = 0; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the time after which requests are allowed. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual base::TimeTicks GetExponentialBackoffReleaseTime() const = 0; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method needs to be called each time a response is received. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void UpdateWithResponse( 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& host, 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const URLRequestThrottlerHeaderInterface* response) = 0; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Lets higher-level modules, that know how to parse particular response 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // bodies, notify of receiving malformed content for the given URL. This will 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // be handled by the throttler as if an HTTP 503 response had been received to 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the request, i.e. it will count as a failure, unless the HTTP response code 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // indicated is already one of those that will be counted as an error. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ReceivedContentWasMalformed(int response_code) = 0; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class base::RefCountedThreadSafe<URLRequestThrottlerEntryInterface>; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~URLRequestThrottlerEntryInterface() {} 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class base::RefCounted<URLRequestThrottlerEntryInterface>; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(URLRequestThrottlerEntryInterface); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_URL_REQUEST_URL_REQUEST_THROTTLER_ENTRY_INTERFACE_H_ 74