pageCacheCommitRequest.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_EF_PAGE_CACHE_COMMIT_REQUEST_H
#define PXR_EXEC_EF_PAGE_CACHE_COMMIT_REQUEST_H


#include "pxr/pxr.h"

#include "pxr/exec/ef/api.h"
#include "pxr/exec/ef/inputValueBlock.h"

#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

class Ef_OutputValueCache;
class EfPageCacheStorage;
class VdfExecutorInterface;
class VdfRequest;

class EfPageCacheCommitRequest
{
public:
    EF_API
    EfPageCacheCommitRequest(
        const EfInputValueBlock &inputs,
        EfPageCacheStorage *storage);

    EF_API
    ~EfPageCacheCommitRequest();

    const EfInputValueBlock &GetInputs() const {
        return _inputs;
    }

    Ef_OutputValueCache *GetCache() const {
        return _cache;
    }

    EF_API
    bool IsUncached(const VdfRequest &request) const;

    EF_API
    VdfRequest GetUncached(const VdfRequest &request) const;

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

private:
    // The input value block containing the key output value.
    EfInputValueBlock _inputs;

    // The output-to-value cache on the page indexed by the key value.
    Ef_OutputValueCache *_cache;

    // A pointer to the page cache storage class.
    EfPageCacheStorage *_storage;

};

typedef std::vector<EfPageCacheCommitRequest> EfPageCacheCommitRequestVector;

PXR_NAMESPACE_CLOSE_SCOPE

#endif