15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 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_HTTP_HTTP_BYTE_RANGE_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_HTTP_HTTP_BYTE_RANGE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include <string> 9f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A container class that represents a "range" specified for range request 16f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)// specified by RFC 7233 Section 2.1. 17f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)// https://tools.ietf.org/html/rfc7233#section-2.1 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT HttpByteRange { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HttpByteRange(); 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 22f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Convenience constructors. 23f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) static HttpByteRange Bounded(int64 first_byte_position, 24f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) int64 last_byte_position); 25f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) static HttpByteRange RightUnbounded(int64 first_byte_position); 26f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) static HttpByteRange Suffix(int64 suffix_length); 27f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Since this class is POD, we use constructor, assignment operator 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and destructor provided by compiler. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 first_byte_position() const { return first_byte_position_; } 31f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) void set_first_byte_position(int64 value) { first_byte_position_ = value; } 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 last_byte_position() const { return last_byte_position_; } 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_last_byte_position(int64 value) { last_byte_position_ = value; } 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 suffix_length() const { return suffix_length_; } 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_suffix_length(int64 value) { suffix_length_ = value; } 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if this is a suffix byte range. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsSuffixByteRange() const; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the first byte position is specified in this request. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool HasFirstBytePosition() const; 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the last byte position is specified in this request. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool HasLastBytePosition() const; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if this range is valid. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsValid() const; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 49f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Gets the header string, e.g. "bytes=0-100", "bytes=100-", "bytes=-100". 50f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Assumes range is valid. 51f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) std::string GetHeaderValue() const; 52f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A method that when given the size in bytes of a file, adjust the internal 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |first_byte_position_| and |last_byte_position_| values according to the 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // range specified by this object. If the range specified is invalid with 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // regard to the size or |size| is negative, returns false and there will be 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // no side effect. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns false if this method is called more than once and there will be 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // no side effect. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ComputeBounds(int64 size); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 first_byte_position_; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 last_byte_position_; 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 suffix_length_; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool has_computed_bounds_; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_HTTP_HTTP_BYTE_RANGE_H_ 72