mirror of
https://github.com/klzgrad/naiveproxy.git
synced 2024-11-28 16:26:10 +03:00
93 lines
3.4 KiB
C++
93 lines
3.4 KiB
C++
// Copyright (c) 2017 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.
|
|
|
|
#ifndef NET_THIRD_PARTY_QUIC_QUARTC_QUARTC_STREAM_INTERFACE_H_
|
|
#define NET_THIRD_PARTY_QUIC_QUARTC_QUARTC_STREAM_INTERFACE_H_
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#include "net/third_party/quic/platform/api/quic_export.h"
|
|
#include "net/third_party/quic/platform/api/quic_mem_slice_span.h"
|
|
|
|
namespace net {
|
|
|
|
// Sends and receives data with a particular QUIC stream ID, reliably and
|
|
// in-order. To send/receive data out of order, use separate streams. To
|
|
// send/receive unreliably, close a stream after reliability is no longer
|
|
// needed.
|
|
class QUIC_EXPORT_PRIVATE QuartcStreamInterface {
|
|
public:
|
|
virtual ~QuartcStreamInterface() {}
|
|
|
|
// The QUIC stream ID.
|
|
virtual uint32_t stream_id() = 0;
|
|
|
|
// The amount of data buffered on this stream.
|
|
virtual uint64_t bytes_buffered() = 0;
|
|
|
|
// Return true if the FIN has been sent. Used by the outgoing streams to
|
|
// determine if all the data has been sent
|
|
virtual bool fin_sent() = 0;
|
|
|
|
virtual int stream_error() = 0;
|
|
|
|
struct WriteParameters {
|
|
// |fin| is set to be true when there is no more data need to be send
|
|
// through a particular stream. The receiving side will used it to determine
|
|
// if the sender finish sending data.
|
|
bool fin = false;
|
|
};
|
|
|
|
// Sends data reliably and in-order. Returns the amount sent.
|
|
// Does not buffer data.
|
|
virtual void Write(QuicMemSliceSpan data, const WriteParameters& param) = 0;
|
|
|
|
// Marks this stream as finished writing. Asynchronously sends a FIN and
|
|
// closes the write-side. The stream will no longer call OnCanWrite().
|
|
// It is not necessary to call FinishWriting() if the last call to Write()
|
|
// sends a FIN.
|
|
virtual void FinishWriting() = 0;
|
|
|
|
// Marks this stream as finished reading. Further incoming data is discarded.
|
|
// The stream will no longer call OnReceived().
|
|
// It is never necessary to call FinishReading(). The read-side closes when a
|
|
// FIN is received, regardless of whether FinishReading() has been called.
|
|
virtual void FinishReading() = 0;
|
|
|
|
// Once Close is called, no more data can be sent, all buffered data will be
|
|
// dropped and no data will be retransmitted.
|
|
virtual void Close() = 0;
|
|
|
|
// Implemented by the user of the QuartcStreamInterface to receive incoming
|
|
// data and be notified of state changes.
|
|
class Delegate {
|
|
public:
|
|
virtual ~Delegate() {}
|
|
|
|
// Called when the stream receives the data. Called with |size| == 0 after
|
|
// all stream data has been delivered.
|
|
virtual void OnReceived(QuartcStreamInterface* stream,
|
|
const char* data,
|
|
size_t size) = 0;
|
|
|
|
// Called when the stream is closed, either locally or by the remote
|
|
// endpoint. Streams close when (a) fin bits are both sent and received,
|
|
// (b) Close() is called, or (c) the stream is reset.
|
|
// TODO(zhihuang) Creates a map from the integer error_code to WebRTC native
|
|
// error code.
|
|
virtual void OnClose(QuartcStreamInterface* stream) = 0;
|
|
|
|
// Called when the contents of the stream's buffer changes.
|
|
virtual void OnBufferChanged(QuartcStreamInterface* stream) = 0;
|
|
};
|
|
|
|
// The |delegate| is not owned by QuartcStream.
|
|
virtual void SetDelegate(Delegate* delegate) = 0;
|
|
};
|
|
|
|
} // namespace net
|
|
|
|
#endif // NET_THIRD_PARTY_QUIC_QUARTC_QUARTC_STREAM_INTERFACE_H_
|