ovsdb_object.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014 Juniper Networks, Inc. All rights reserved.
 */
 
#ifndef SRC_VNSW_AGENT_OVS_TOR_AGENT_OVSDB_CLIENT_OVSDB_OBJECT_H_
#define SRC_VNSW_AGENT_OVS_TOR_AGENT_OVSDB_CLIENT_OVSDB_OBJECT_H_
 
#include <boost/intrusive_ptr.hpp>
 
#include <db/db_entry.h>
#include <ksync/ksync_entry.h>
#include <ksync/ksync_index.h>
#include <ksync/ksync_object.h>
 
#include <ovsdb_client_idl.h>
 
namespace OVSDB {
class OvsdbDBEntry;
 
class OvsdbObject : public KSyncObject {
public:
    OvsdbObject(OvsdbClientIdl *idl);
    virtual ~OvsdbObject();
 
    KSyncEntry *FindActiveEntry(KSyncEntry *key);
    // Trigger delete of object table
    void DeleteTable(void);
 
    virtual void EmptyTable(void);
 
    OvsdbClientIdl *client_idl() { return client_idl_.get();}
 
protected:
    OvsdbClientIdlPtr client_idl_;
 
    // derived class can override to take action on delete table.
    virtual void DeleteTableDone(void) {}
 
private:
    DISALLOW_COPY_AND_ASSIGN(OvsdbObject);
};
 
class OvsdbDBObject : public KSyncDBObject {
public:
    static const uint32_t StaleEntryCleanupTimer = 300000;          // 5 mins
    static const uint32_t StaleEntryYeildTimer = 100;               // 100 ms
    static const uint16_t StaleEntryDeletePerIteration = 32;
 
    OvsdbDBObject(OvsdbClientIdl *idl, bool init_stale_entry_cleanup);
    OvsdbDBObject(OvsdbClientIdl *idl, DBTable *tbl,
                  bool init_stale_entry_cleanup);
    virtual ~OvsdbDBObject();
 
    // API to register db table, if not already registered.
    virtual void OvsdbRegisterDBTable(DBTable *tbl);
 
    // API to trigger db table walk to resync the entries.
    void OvsdbStartResyncWalk();
 
    void NotifyAddOvsdb(OvsdbDBEntry *key, struct ovsdb_idl_row *row);
    void NotifyDeleteOvsdb(OvsdbDBEntry *key, struct ovsdb_idl_row *row);
 
    virtual OvsdbDBEntry *AllocOvsEntry(struct ovsdb_idl_row *row) { return NULL;}
    bool DBWalkNotify(DBTablePartBase *partition, DBEntryBase *entry);
    void DBWalkDone(DBTableBase *partition);
 
    virtual Agent *agent() const;
 
    // Trigger delete of object table
    void DeleteTable(void);
 
    virtual void EmptyTable(void);
    virtual DBFilterResp OvsdbDBEntryFilter(const DBEntry *entry,
                                            const OvsdbDBEntry *ovsdb_entry);
 
    OvsdbClientIdl *client_idl() { return client_idl_.get();}
protected:
    DBFilterResp DBEntryFilter(const DBEntry *entry, const KSyncDBEntry *ksync);
 
    // derived class can override to take action on delete table.
    virtual void DeleteTableDone(void) {}
 
    OvsdbClientIdlPtr client_idl_;
 
private:
    friend class OvsdbDBEntry;
    DBTable::DBTableWalkRef walk_ref_;
    bool delete_triggered_;
    DISALLOW_COPY_AND_ASSIGN(OvsdbDBObject);
};
};
 
#endif //SRC_VNSW_AGENT_OVS_TOR_AGENT_OVSDB_CLIENT_OVSDB_OBJECT_H_