libMesh::ThreadBufferedSyncbuf Class Reference

#include <thread_buffered_syncbuf.h>

Inheritance diagram for libMesh::ThreadBufferedSyncbuf:

Classes
class	ThreadLocalBuffer
	A class that wraps a thread-local string. More...

Public Member Functions
	ThreadBufferedSyncbuf (std::streambuf &sink, bool flush_on_newline=true)
	~ThreadBufferedSyncbuf ()
	Defaulted destructor defined in implementation so we don't need to include threads.h. More...

Protected Member Functions
int_type	overflow (int_type ch) override
std::streamsize	xsputn (const char *s, std::streamsize n) override
int	sync () override

Private Member Functions
ThreadLocalBuffer &	thread_local_buffer ()
	One ThreadLocalBuffer instance per thread, constructed on first use with *this. More...
void	emit_from_thread_local_buffer (std::string &b, bool force_flush)
	Emit from the thread local buffer to our wrapped _sink. More...

Private Attributes
std::streambuf &	_sink
	Wrapped output sink. More...
const bool	_flush_on_newline
	Whether to flush our sink to terminal/file on terminating new-line characters ( ) More...
std::unique_ptr< Threads::spin_mutex >	_mu
	Serialization for commits to the shared sink. More...

Detailed Description

Definition at line 32 of file thread_buffered_syncbuf.h.

Constructor & Destructor Documentation

ThreadBufferedSyncbuf()

libMesh::ThreadBufferedSyncbuf::ThreadBufferedSyncbuf ( std::streambuf &  sink, bool  flush_on_newline = true  )

explicit

Definition at line 23 of file thread_buffered_syncbuf.C.

  : _sink(sink), _flush_on_newline(flush_on_newline), _mu(std::make_unique<Threads::spin_mutex>())
{
}

~ThreadBufferedSyncbuf()

libMesh::ThreadBufferedSyncbuf::~ThreadBufferedSyncbuf ( )

default

Defaulted destructor defined in implementation so we don't need to include threads.h.

Member Function Documentation

emit_from_thread_local_buffer()

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

private

Emit from the thread local buffer to our wrapped _sink.

Definition at line 67 of file thread_buffered_syncbuf.C.

References _mu, and _sink.

Referenced by overflow(), sync(), xsputn(), and libMesh::ThreadBufferedSyncbuf::ThreadLocalBuffer::~ThreadLocalBuffer().

{
  if (b.empty())
    {
      if (force_flush)
        {
          Threads::spin_mutex::scoped_lock lk(*_mu);
          _sink.pubsync();
        }
      return;
    }

  {
    Threads::spin_mutex::scoped_lock lk(*_mu);
    _sink.sputn(b.data(), static_cast<std::streamsize>(b.size()));
    if (force_flush)
      _sink.pubsync();
  }
  b.clear();
}

overflow()

ThreadBufferedSyncbuf::int_type libMesh::ThreadBufferedSyncbuf::overflow ( int_type  ch )

overrideprotected

Definition at line 30 of file thread_buffered_syncbuf.C.

References _flush_on_newline, emit_from_thread_local_buffer(), and thread_local_buffer().

{
  if (traits_type::eq_int_type(ch, traits_type::eof()))
    return traits_type::not_eof(ch);

  auto & t = this->thread_local_buffer();
  t.buf.push_back(traits_type::to_char_type(ch));

  if (_flush_on_newline && ch == '\n')
    this->emit_from_thread_local_buffer(t.buf, /*force_flush=*/false);

  return ch;
}

sync()

int libMesh::ThreadBufferedSyncbuf::sync ( )

overrideprotected

Definition at line 55 of file thread_buffered_syncbuf.C.

References emit_from_thread_local_buffer(), and thread_local_buffer().

{
  this->emit_from_thread_local_buffer(this->thread_local_buffer().buf, /*force_flush=*/true);
  return 0;
}

thread_local_buffer()

ThreadBufferedSyncbuf::ThreadLocalBuffer & libMesh::ThreadBufferedSyncbuf::thread_local_buffer ( )

private

One ThreadLocalBuffer instance per thread, constructed on first use with *this.

Definition at line 61 of file thread_buffered_syncbuf.C.

Referenced by overflow(), sync(), and xsputn().

{
  static thread_local ThreadLocalBuffer t(*this);
  return t;
}

xsputn()

std::streamsize libMesh::ThreadBufferedSyncbuf::xsputn ( const char *  s, std::streamsize  n  )

overrideprotected

Definition at line 44 of file thread_buffered_syncbuf.C.

References _flush_on_newline, emit_from_thread_local_buffer(), and thread_local_buffer().

{
  auto & t = this->thread_local_buffer();
  t.buf.append(s, static_cast<size_t>(n));

  if (_flush_on_newline && !t.buf.empty() && t.buf.back() == '\n')
    this->emit_from_thread_local_buffer(t.buf, /*force_flush=*/false);

  return n;
}

Member Data Documentation

_flush_on_newline

const bool libMesh::ThreadBufferedSyncbuf::_flush_on_newline

private

Whether to flush our sink to terminal/file on terminating new-line characters (
)

Definition at line 88 of file thread_buffered_syncbuf.h.

Referenced by overflow(), and xsputn().

_mu

std::unique_ptr<Threads::spin_mutex> libMesh::ThreadBufferedSyncbuf::_mu

private

Serialization for commits to the shared sink.

Definition at line 91 of file thread_buffered_syncbuf.h.

Referenced by emit_from_thread_local_buffer().

_sink

std::streambuf& libMesh::ThreadBufferedSyncbuf::_sink

private

Wrapped output sink.

Definition at line 86 of file thread_buffered_syncbuf.h.

Referenced by emit_from_thread_local_buffer().

---

The documentation for this class was generated from the following files:

• include/utils/thread_buffered_syncbuf.h
• src/utils/thread_buffered_syncbuf.C