IFlushable

Description

interface Tinman.Core.IO.IFlushable

Base interface for classes that perform caching and provide a flush method.

Usually, implementing classes cache I/O work. However, this interface does not restrict implementors to cache only read and write accesses. For example, a class may choose to buffer commands; in this case, flushing will force all buffered commands to be executed.

Public / Methods

Flush


public method Flush → ()

Flushes all cached data.

Performing a flush may result in I/O work. Depending on the semantics of the implementing class, this work may need to be wrapped in special Begin/End method calls. See the documentation of the implementing classes for details.

In case this object represents a read-only resource, calling the Flush method has no effect.

IOException

If an I/O error has occurred.