blob: 12d834d605446fad5728df4ab1b0de137c457ae5 [file] [log] [blame]
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <string>
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "net/base/completion_once_callback.h"
#include "net/base/net_errors.h"
#include "net/base/net_export.h"
namespace net {
class IOBuffer;
// The SourceStream class implements a producer of bytes.
class NET_EXPORT_PRIVATE SourceStream {
enum SourceType {
#define SOURCE_STREAM_TYPE(label) TYPE_##label,
#include "net/filter/source_stream_type_list.h"
// Used for UMA.
// |type| is the type of the SourceStream.
explicit SourceStream(SourceType type);
virtual ~SourceStream();
// Initiaties a read from the stream.
// If it completes synchronously, it:
// - Returns an int representing the number of bytes read. If 0, EOF has
// been reached
// - Bytes will be written into |*dest_buffer|
// - Does not call |callback|
// If it completes asynchronously, it:
// - Returns ERR_IO_PENDING
// - Calls |callback| when it does complete, with an error code or a count
// of bytes read and written into |*dest_buffer|.
// This method takes a reference to |*dest_buffer| if it completes
// asynchronously to ensure it does not get freed mid-read.
virtual int Read(IOBuffer* dest_buffer,
int buffer_size,
CompletionOnceCallback callback) = 0;
// Returns a string that represents stream. This is for UMA and NetLog
// logging.
virtual std::string Description() const = 0;
SourceType type() const { return type_; }
SourceType type_;
} // namespace net