Instance.h

Go to the documentation of this file.

/*
 *Instance.h
 *
 *  Created on: 6 Jul 2023
 *      Author: valentin
 */
 
#ifndef WPP_INSTANCE_H_
#define WPP_INSTANCE_H_
 
#include <vector>
 
#include "liblwm2m.h"
#include "Resource.h"
#include "ItemOp.h"
#include "WppTypes.h"
#include "InstSubject.h"
#include "ResourceContainer.h"
 
namespace wpp {
 
class WppRegistry;
class WppClient;
 
class Instance: public InstSubject, public ResourceContainer {
public:
    Instance(lwm2m_context_t &context, const OBJ_LINK_T &id): _context(context), _id(id) {}
    virtual ~Instance() {}
 
    Instance(const Instance&) = delete;
    Instance(Instance&&) = delete;
    Instance& operator=(const Instance&) = delete;
    Instance& operator=(Instance&&) = delete;
 
    /* ------------- User helpful methods ------------- */
    OBJ_LINK_T getLink() const { return _id; }
    OBJ_ID getObjectID() const { return (OBJ_ID)_id.objId; }
    ID_T getInstanceID() const { return _id.objInstId; }
 
    lwm2m_context_t& getContext();
 
    WppClient& getClient();
 
    WppRegistry& getRegistry();
 
    /* ------------- Server operation methods ------------- */
    uint8_t readAsServer(lwm2m_server_t *server, int *numDataP, lwm2m_data_t **dataArray);
    uint8_t writeAsServer(lwm2m_server_t *server, int numData, lwm2m_data_t *dataArray, lwm2m_write_type_t writeType);
    uint8_t executeAsServer(lwm2m_server_t *server, ID_T resId, uint8_t *buffer, int length);
    uint8_t discoverAsServer(lwm2m_server_t *server, int * numDataP, lwm2m_data_t **dataArray);
 
protected: /* Interface that can be used by derived class */
    void notifyResChanged(ID_T resId, ID_T resInstId = ID_T_MAX_VAL);
 
    std::vector<Resource *> getInstantiatedResList();
    std::vector<Resource *> getInstantiatedResList(const ItemOp& filter);
 
    std::vector<Resource *> getResList();
 
    void resourceOperationNotifier(ItemOp::TYPE type, ID_T resId, ID_T resInstId) override;
 
 
protected: /* Interface that must be implemented by derived class */
    virtual void serverOperationNotifier(Instance *securityInst, ItemOp::TYPE type, const ResLink &resLink) = 0;
 
    virtual void userOperationNotifier(ItemOp::TYPE type, const ResLink &resLink) = 0;
 
private: /* Interface used by Object or Instance class */
    Instance *getSecurityInst(lwm2m_server_t *server);
 
    /* ------------- Compatibility with core data structure ------------- */
    bool resourceToLwm2mData(Resource &res, ID_T instanceId, lwm2m_data_t &data);
    bool lwm2mDataToResource(const lwm2m_data_t &data, Resource &res, ID_T instanceId);
 
    /* ------------- Helpful methods for server callbacks ------------- */
    Resource* getValidatedResForWrite(const lwm2m_data_t &data, lwm2m_write_type_t writeType, uint8_t &errCode);
    uint8_t resourceWrite(lwm2m_server_t *server, Resource &res, const lwm2m_data_t &data, lwm2m_write_type_t writeType);
    Resource* getValidatedResForRead(const lwm2m_data_t &data, uint8_t &errCode);
    uint8_t resourceRead(lwm2m_server_t *server, lwm2m_data_t &data, Resource &res);
    Resource* getValidatedResForExecute(ID_T resId, uint8_t &errCode);
    uint8_t createEmptyLwm2mDataArray(std::vector<Resource*> resources, lwm2m_data_t **dataArray, int *numData);
    bool isAllMandatoryResourcesPresent(int numData, lwm2m_data_t *data);
    uint8_t replaceInstance(lwm2m_server_t *server, int numData, lwm2m_data_t *dataArray);
    uint8_t replaceResource(lwm2m_server_t *server, int numData, lwm2m_data_t *dataArray, lwm2m_write_type_t writeType);
 
private:
    lwm2m_context_t &_context;
    OBJ_LINK_T _id;
};
 
} /* namespace wpp */
 
#endif /* WPP_INSTANCE_H_ */