thread_buffered_syncbuf.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef LIBMESH_THREAD_BUFFERED_SYNCBUF_H
#define LIBMESH_THREAD_BUFFERED_SYNCBUF_H

#include <streambuf>
#include <string>
#include <memory>

#include "libmesh/threads_spin_mutex_forward.h"

namespace libMesh
{

class ThreadBufferedSyncbuf : public std::streambuf
{
public:
  explicit ThreadBufferedSyncbuf(std::streambuf & sink, bool flush_on_newline = true);

  ~ThreadBufferedSyncbuf();

protected:
  // Single-char path
  int_type overflow(int_type ch) override;

  // Bulk write path
  std::streamsize xsputn(const char * s, std::streamsize n) override;

  // Flush path (std::flush / std::endl / ostream::flush)
  int sync() override;

private:
  class ThreadLocalBuffer
  {
  public:
    explicit ThreadLocalBuffer(ThreadBufferedSyncbuf & owner) : _owner(owner) {}

    ~ThreadLocalBuffer();

    std::string buf;

  private:
    ThreadBufferedSyncbuf & _owner;
  };

  ThreadLocalBuffer & thread_local_buffer();

  void emit_from_thread_local_buffer(std::string & b, bool force_flush);

  std::streambuf & _sink;
  const bool _flush_on_newline;

  std::unique_ptr<Threads::spin_mutex> _mu;
};

}
#endif // LIBMESH_THREAD_BUFFERED_SYNCBUF_H