OFFramework.h

Go to the documentation of this file.

/* -*- C++ -*-; c-basic-offset: 4; indent-tabs-mode: nil */
/*
 * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

#pragma once
#ifndef OPFLEX_CORE_OFFRAMEWORK_H
#define OPFLEX_CORE_OFFRAMEWORK_H

#include <vector>
#include <string>

#include <boost/noncopyable.hpp>

#include "opflex/modb/Mutator.h"
#include "opflex/ofcore/PeerStatusListener.h"
#include "opflex/ofcore/MainLoopAdaptor.h"

namespace opflex {
namespace modb {
class ObjectStore;
class ModelMetadata;
namespace mointernal {
class MO;
}
}

namespace ofcore {

class OFFramework : private boost::noncopyable {
public:
    OFFramework();

    virtual ~OFFramework();

    static const std::vector<int>& getVersion();

    static const std::string& getVersionStr();

    static OFFramework& defaultInstance();

    void setModel(const modb::ModelMetadata& model);

    void setOpflexIdentity(const std::string& name,
                           const std::string& domain);

    void setOpflexIdentity(const std::string& name,
                           const std::string& domain,
                           const std::string& location);

    virtual void start();

    virtual void stop();

    virtual MainLoopAdaptor* startSync();

    virtual void dumpMODB(const std::string& file);

    virtual void dumpMODB(FILE* file);

    virtual void prettyPrintMODB(std::ostream& output,
                                 bool tree = true,
                                 bool includeProps = true,
                                 bool utf8 = true,
                                 size_t truncate = 0);

    virtual void enableSSL(const std::string& caStorePath,
                   bool verifyPeers = true);

    virtual void enableSSL(const std::string& caStorePath,
                           const std::string& keyAndCertFilePath,
                           const std::string& passphrase,
                           bool verifyPeers = true);

    virtual void enableInspector(const std::string& socketName);

    virtual void addPeer(const std::string& hostname,
                         int port);

    virtual void registerPeerStatusListener(PeerStatusListener* listener);

private:
    modb::ObjectStore& getStore();

    void registerTLMutator(modb::Mutator& mutator);
    modb::Mutator& getTLMutator();
    void clearTLMutator();

    class OFFrameworkImpl;
    OFFrameworkImpl* pimpl;

    friend class OFFrameworkImpl;
    friend class modb::Mutator;
    friend class modb::mointernal::MO;
    friend class MockOFFramework;
};

class MockOFFramework : public OFFramework {
public:
    MockOFFramework() : OFFramework() { }
    virtual ~MockOFFramework() {};

    virtual void start();
    virtual void stop();
};

} /* namespace ofcore */
} /* namespace opflex */

#endif /* OPFLEX_CORE_OFFRAMEWORK_H */