This object signifies an intent to commit data to a page cache. More...

#include <pageCacheCommitRequest.h>

Public Member Functions
EF_API	EfPageCacheCommitRequest (const EfInputValueBlock &inputs, EfPageCacheStorage *storage)
	Constructor.

EF_API	~EfPageCacheCommitRequest ()
	Destructor.

const EfInputValueBlock &	GetInputs () const
	Returns the input value block containing the key output value.

Ef_OutputValueCache *	GetCache () const
	Returns the output value cache where values will be committed to.

EF_API bool	IsUncached (const VdfRequest &request) const
	Returns `true` if any output in the specified `request` is still not cached.

EF_API VdfRequest	GetUncached (const VdfRequest &request) const
	Returns the subset of `request`, which is still not cached.

EF_API bool	Commit (const VdfExecutorInterface &executor, const VdfRequest &request, size_t *bytesCommitted)
	Commits data for the outputs denoted by the `request` to the cache, reading their values from the specified `executor`.

Detailed Description

This object signifies an intent to commit data to a page cache.

It ensures that the page exists and that it is ready to accept the data. The object also stores an input value block, which denotes the cache page to be used for the commit operation.

Definition at line 35 of file pageCacheCommitRequest.h.

Constructor & Destructor Documentation

◆ EfPageCacheCommitRequest()

EF_API EfPageCacheCommitRequest	(	const EfInputValueBlock &	inputs,
		EfPageCacheStorage *	storage
	)

Constructor.

Creates a new commit request with the specified input values, denoting the cache page (key), as well as the page cache storage to which the data will be committed.

◆ ~EfPageCacheCommitRequest()

EF_API ~EfPageCacheCommitRequest ( )

Destructor.

Member Function Documentation

◆ Commit()

EF_API bool Commit	(	const VdfExecutorInterface &	executor,
		const VdfRequest &	request,
		size_t *	bytesCommitted
	)

Commits data for the outputs denoted by the request to the cache, reading their values from the specified executor.

Returns true if all the data has been cached.

Sets bytesCommitted (which must be non-null) to the size of the stored data, in bytes.

◆ GetCache()

Ef_OutputValueCache * GetCache ( ) const

inline

Returns the output value cache where values will be committed to.

Definition at line 62 of file pageCacheCommitRequest.h.

◆ GetInputs()

const EfInputValueBlock & GetInputs ( ) const

inline

Returns the input value block containing the key output value.

Definition at line 56 of file pageCacheCommitRequest.h.

◆ GetUncached()

EF_API VdfRequest GetUncached ( const VdfRequest & request ) const

Returns the subset of request, which is still not cached.

◆ IsUncached()

EF_API bool IsUncached ( const VdfRequest & request ) const

Returns true if any output in the specified request is still not cached.

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

pxr/exec/ef/pageCacheCommitRequest.h

Public Member Functions