Workspace 6.21.5
Public Member Functions | List of all members
IOBase::QueueChangesWhileUpdatingSentry Class Reference

#include <Workspace/DataExecution/InputOutput/iobase.h>

Public Member Functions

 QueueChangesWhileUpdatingSentry (IOBase &object, Updater *updater)
 
 ~QueueChangesWhileUpdatingSentry ()
 

Detailed Description

This is a convenience class that can be created on the stack during an IOBase update function to notify the Updater if it should queue any data changes while this object is updated. When this helper goes out of scope it will remove the IOBase from the queuing list if it was added.

Constructor & Destructor Documentation

◆ QueueChangesWhileUpdatingSentry()

QueueChangesWhileUpdatingSentry ( IOBase object,
Updater updater 
)

This sentry class will check if the updater is already queuing data changes (because of something downstream on the update path). If the Updater isn't already queuing and the provided IOBase requires it then it will notify the Updater that it should now queue.

Parameters
objectThe IOBase that may require queuing.
updaterThe Updater that will update this IOBase

◆ ~QueueChangesWhileUpdatingSentry()