ChunkManager.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 * 
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the LSST License Statement and 
 * the GNU General Public License along with this program.  If not, 
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 

#ifndef LSST_AP_CHUNK_MANAGER_H
#define LSST_AP_CHUNK_MANAGER_H

#include <iosfwd>

#include "ChunkManagerImpl.h"
#include "Object.h"


namespace lsst { namespace ap {

class SharedObjectChunkManager {

private :

    typedef detail::ChunkManagerImpl<SharedMutex, Object> Manager;

    Manager * _manager;

    static Manager * instance(std::string const & name);

public :

    typedef Manager::Chunk ObjectChunk;

    SharedObjectChunkManager(std::string const & name);

    bool isVisitInFlight(int const visitId) {
        return _manager->isVisitInFlight(visitId);
    }
    void registerVisit(int const visitId) {
        _manager->registerVisit(visitId);
    }
    void failVisit(int const visitId) {
        _manager->failVisit(visitId);
    }

    void startVisit(
        std::vector<ObjectChunk> & toRead,
        std::vector<ObjectChunk> & toWaitFor,
        int const visitId,
        std::vector<int> const & chunkIds
    ) {
        _manager->startVisit(toRead, toWaitFor, visitId, chunkIds);
    }

    void waitForOwnership(
        std::vector<ObjectChunk> & toRead,
        std::vector<ObjectChunk> & toWaitFor,
        int const visitId,
        TimeSpec const & deadline
    ) {
        _manager->waitForOwnership(toRead, toWaitFor, visitId, deadline);
    }

    void getChunks(
        std::vector<ObjectChunk> & chunks,
        std::vector<int> const & chunkIds
    ) {
        _manager->getChunks(chunks, chunkIds);
    }

    bool endVisit(int const visitId, bool const rollback) {
        return _manager->endVisit(visitId, rollback);
    }

    void printVisits(std::ostream & os) const {
        _manager->printVisits(os);
    }
    void printChunks(std::ostream & os) const {
        _manager->printChunks(os);
    }
    void printVisit(int const visitId, std::ostream & os) const {
        _manager->printVisit(visitId, os);
    }
    void printChunk(int const chunkId, std::ostream & os) const {
        _manager->printChunk(chunkId, os);
    }

    static void destroyInstance(std::string const & name);

    static std::size_t size();
};


}} // end of namespace lsst::ap

#endif // LSST_AP_CHUNK_MANAGER_H