blob: 4b0abf4456842fbc2fe2808a370d4ac302fed964 [file] [log] [blame]
// Copyright (c) 2012 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 QUICHE_QUIC_CORE_QUIC_BUFFER_ALLOCATOR_H_
#define QUICHE_QUIC_CORE_QUIC_BUFFER_ALLOCATOR_H_
#include <stddef.h>
#include <memory>
#include "net/third_party/quiche/src/quic/platform/api/quic_export.h"
namespace quic {
// Abstract base class for classes which allocate and delete buffers.
class QUIC_EXPORT_PRIVATE QuicBufferAllocator {
public:
virtual ~QuicBufferAllocator();
// Returns or allocates a new buffer of |size|. Never returns null.
virtual char* New(size_t size) = 0;
// Returns or allocates a new buffer of |size| if |flag_enable| is true.
// Otherwise, returns a buffer that is compatible with this class directly
// with operator new. Never returns null.
virtual char* New(size_t size, bool flag_enable) = 0;
// Releases a buffer.
virtual void Delete(char* buffer) = 0;
// Marks the allocator as being idle. Serves as a hint to notify the allocator
// that it should release any resources it's still holding on to.
virtual void MarkAllocatorIdle() {}
};
// A deleter that can be used to manage ownership of buffers allocated via
// QuicBufferAllocator through std::unique_ptr.
class QUIC_EXPORT_PRIVATE QuicBufferDeleter {
public:
explicit QuicBufferDeleter(QuicBufferAllocator* allocator)
: allocator_(allocator) {}
QuicBufferAllocator* allocator() { return allocator_; }
void operator()(char* buffer) { allocator_->Delete(buffer); }
private:
QuicBufferAllocator* allocator_;
};
using QuicUniqueBufferPtr = std::unique_ptr<char[], QuicBufferDeleter>;
inline QuicUniqueBufferPtr MakeUniqueBuffer(QuicBufferAllocator* allocator,
size_t size) {
return QuicUniqueBufferPtr(allocator->New(size),
QuicBufferDeleter(allocator));
}
} // namespace quic
#endif // QUICHE_QUIC_CORE_QUIC_BUFFER_ALLOCATOR_H_