DiagnosticBufferProvider Class Reference

#include "steam/engine/diagnostic-buffer-provider.hpp"

Description

Helper for unit tests: Buffer provider reference implementation.

Todo:

write type comment

Definition at line 52 of file diagnostic-buffer-provider.hpp.

Static Public Member Functions
static BufferProvider &	build ()
	build a new Diagnostic Buffer Provider instance, discard the existing one.
static DiagnosticBufferProvider &	access (BufferProvider const &)
	access the diagnostic API of the buffer provider

Public Member Functions
bool	buffer_was_used (uint bufferID) const
bool	buffer_was_closed (uint bufferID) const
void *	accessMemory (uint bufferID) const
bool	all_buffers_released () const

Friends
class	lib::DependencyFactory< DiagnosticBufferProvider >

Private Member Functions
TrackingHeapBlockProvider &	reset ()
bool	isCurrent (BufferProvider const &)
	DiagnosticBufferProvider ()
	~DiagnosticBufferProvider ()
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default
	NonCopyable ()=default
	NonCopyable (NonCopyable const &)=delete
NonCopyable &	operator= (NonCopyable const &)=delete

Private Attributes
std::unique_ptr< TrackingHeapBlockProvider >	pImpl_

Static Private Attributes
static lib::Depend< DiagnosticBufferProvider >	diagnostics
	Storage for the diagnostics frontend.

Constructor & Destructor Documentation

DiagnosticBufferProvider()

DiagnosticBufferProvider ( )

private

Definition at line 40 of file diagnostic-buffer-provider.cpp.

~DiagnosticBufferProvider()

~DiagnosticBufferProvider ( )

private

Definition at line 44 of file diagnostic-buffer-provider.cpp.

Member Function Documentation

reset()

TrackingHeapBlockProvider & reset ( )

private

Definition at line 68 of file diagnostic-buffer-provider.cpp.

References TrackingHeapBlockProvider::markAllEmitted(), and DiagnosticBufferProvider::pImpl_.

Here is the call graph for this function:

isCurrent()

bool isCurrent ( BufferProvider const &  implInstance )

private

Definition at line 77 of file diagnostic-buffer-provider.cpp.

References DiagnosticBufferProvider::pImpl_.

Referenced by DiagnosticBufferProvider::access().

Here is the caller graph for this function:

build()

BufferProvider & build ( )

static

build a new Diagnostic Buffer Provider instance, discard the existing one.

Use the static query API for investigating collected data.

Definition at line 48 of file diagnostic-buffer-provider.cpp.

References DiagnosticBufferProvider::diagnostics.

Referenced by NodeLink_test::build_connected_nodes(), NodeFeed_test::feedParam(), NodeFeed_test::feedParamNode(), NodeBuilder_test::invokeRenderNode(), NodeDevel_test::testRand_buildFilterNode(), NodeDevel_test::testRand_buildMixNode(), NodeDevel_test::testRand_simpleUsage(), NodeLink_test::trigger_node_port_invocation(), NodeBase_test::verify_FeedManifold(), NodeBase_test::verify_FeedPrototype(), NodeBase_test::verify_NodeStructure(), BufferProviderProtocol_test::verifyObjectAttachment(), BufferProviderProtocol_test::verifyObjectAttachmentFailure(), BufferProviderProtocol_test::verifySimpleUsage(), and BufferProviderProtocol_test::verifyStandardCase().

Here is the caller graph for this function:

access()

DiagnosticBufferProvider & access ( BufferProvider const &  provider )

static

access the diagnostic API of the buffer provider

Exceptions

error::Invalid

if the given provider doesn't allow for diagnostic access or wasn't registered beforehand.

Definition at line 55 of file diagnostic-buffer-provider.cpp.

References DiagnosticBufferProvider::diagnostics, and DiagnosticBufferProvider::isCurrent().

Referenced by BufferProviderProtocol_test::verifySimpleUsage(), and BufferProviderProtocol_test::verifyStandardCase().

Here is the call graph for this function:

Here is the caller graph for this function:

buffer_was_used()

bool buffer_was_used

(

uint

bufferID

)

const

Definition at line 89 of file diagnostic-buffer-provider.cpp.

References DiagnosticBufferProvider::pImpl_.

Referenced by BufferProviderProtocol_test::verifySimpleUsage().

Here is the caller graph for this function:

buffer_was_closed()

bool buffer_was_closed

(

uint

bufferID

)

const

Definition at line 96 of file diagnostic-buffer-provider.cpp.

References DiagnosticBufferProvider::pImpl_.

Referenced by BufferProviderProtocol_test::verifySimpleUsage().

Here is the caller graph for this function:

accessMemory()

void * accessMemory

(

uint

bufferID

)

const

Definition at line 103 of file diagnostic-buffer-provider.cpp.

References DiagnosticBufferProvider::pImpl_.

Referenced by BufferProviderProtocol_test::verifySimpleUsage().

Here is the caller graph for this function:

all_buffers_released()

bool all_buffers_released

(

)

const

Referenced by BufferProviderProtocol_test::verifyStandardCase().

Here is the caller graph for this function:

Member Data Documentation

pImpl_

std::unique_ptr<TrackingHeapBlockProvider> pImpl_

private

Definition at line 56 of file diagnostic-buffer-provider.hpp.

Referenced by DiagnosticBufferProvider::accessMemory(), DiagnosticBufferProvider::buffer_was_closed(), DiagnosticBufferProvider::buffer_was_used(), DiagnosticBufferProvider::isCurrent(), and DiagnosticBufferProvider::reset().

diagnostics

lib::Depend< DiagnosticBufferProvider > diagnostics

staticprivate

Storage for the diagnostics frontend.

Definition at line 57 of file diagnostic-buffer-provider.hpp.

Referenced by DiagnosticBufferProvider::access(), and DiagnosticBufferProvider::build().

Friends And Related Symbol Documentation

lib::DependencyFactory< DiagnosticBufferProvider >

friend class lib::DependencyFactory< DiagnosticBufferProvider >

friend

Definition at line 65 of file diagnostic-buffer-provider.hpp.

Inheritance diagram for DiagnosticBufferProvider:

Collaboration diagram for DiagnosticBufferProvider:

---

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

• diagnostic-buffer-provider.hpp
• diagnostic-buffer-provider.cpp