ClientStatus.hpp

Go to the documentation of this file.

/*
 * Copyright 2014 CyberVision, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef CLIENTSTATUS_HPP_
#define CLIENTSTATUS_HPP_

#include <string>
#include <map>
#include <cstdint>
#include <memory>
#include <boost/bimap.hpp>

#include "kaa/KaaThread.hpp"
#include "kaa/gen/EndpointGen.hpp"
#include "kaa/common/EndpointObjectHash.hpp"
#include "kaa/IKaaClientStateStorage.hpp"

namespace kaa {

/* Fwd declarations */
enum class ClientParameterT;
class IPersistentParameter;

typedef boost::bimaps::bimap<
          boost::bimaps::set_of<ClientParameterT>   /* Client parameter type */
        , boost::bimaps::set_of<std::string>        /* String token for mapping in status file */
        , boost::bimaps::left_based
> bimap;

class ClientStatus : public IKaaClientStateStorage {
public:
    ClientStatus(const std::string& filename);
    ~ClientStatus() { }

    std::int32_t getEventSequenceNumber() const;
    void setEventSequenceNumber(std::int32_t sequenceNumber);

    std::int32_t getConfigurationSequenceNumber() const;
    void setConfigurationSequenceNumber(std::int32_t sequenceNumber);

    std::int32_t getNotificationSequenceNumber() const;
    void setNotificationSequenceNumber(std::int32_t sequenceNumber);

    SequenceNumber getAppSeqNumber() const;
    void setAppSeqNumber(SequenceNumber appSeqNumber);

    bool isRegistered() const;
    void setRegistered(bool isRegistered);

    DetailedTopicStates getTopicStates() const;
    void setTopicStates(const DetailedTopicStates& stateContainer);

    HashDigest getProfileHash() const;
    void setProfileHash(HashDigest hash);

    AttachedEndpoints getAttachedEndpoints() const;
    void setAttachedEndpoints(const AttachedEndpoints& endpoints);

    std::string getEndpointAccessToken();
    void setEndpointAccessToken(const std::string& token);
    std::string refreshEndpointAccessToken();

    bool getEndpointAttachStatus() const;
    void setEndpointAttachStatus(bool isAttached);

    std::string getEndpointKeyHash() const;
    void setEndpointKeyHash(const std::string& keyHash);

    virtual bool isConfigurationVersionUpdated() const { return isConfigVersionUpdated; }

    void read();
    void save();

private:
    void checkSDKPropertiesForUpdates();
    void checkConfigVersionForUpdates();

private:
    std::string filename_;
    std::map<ClientParameterT, std::shared_ptr<IPersistentParameter> > parameters_;

    bool isConfigVersionUpdated;

    KAA_MUTEX_MUTABLE_DECLARE(sequenceNumberGuard_);

    static const bimap                      parameterToToken_;
    static const SequenceNumber             appSeqNumberDefault_;
    static const bool                       isRegisteredDefault_;
    static const HashDigest                 endpointHashDefault_;
    static const DetailedTopicStates        topicStatesDefault_;
    static const AttachedEndpoints          attachedEndpoints_;
    static const bool                       endpointDefaultAttachStatus_;
    static const std::string                endpointKeyHashDefault_;
};

}


#endif /* CLIENTSTATUS_HPP_ */