Skip to content

Commit

Permalink
Fix comment
Browse files Browse the repository at this point in the history
Signed-off-by: Ze Gan <[email protected]>
  • Loading branch information
Pterosaur committed Jan 24, 2024
1 parent bf7af35 commit bb4f1df
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 31 deletions.
30 changes: 19 additions & 11 deletions common/dbconnector.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ using json = nlohmann::json;
using namespace std;
using namespace swss;

const SonicDBKey swss::EMPTY_SONIC_DB_KEY;

void SonicDBConfig::parseDatabaseConfig(const string &file,
std::map<std::string, RedisInstInfo> &inst_entry,
Expand Down Expand Up @@ -295,10 +294,11 @@ RedisInstInfo& SonicDBConfig::getRedisInfo(const std::string &dbName, const Soni
return foundRedis->second;
}

string SonicDBConfig::getDbInst(const string &dbName, const string &netns)
string SonicDBConfig::getDbInst(const string &dbName, const string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getDbInst(dbName, key);
}

Expand All @@ -307,10 +307,11 @@ string SonicDBConfig::getDbInst(const std::string &dbName, const SonicDBKey &key
return getDbInfo(dbName, key).instName;
}

int SonicDBConfig::getDbId(const string &dbName, const string &netns)
int SonicDBConfig::getDbId(const string &dbName, const string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getDbId(dbName, key);
}

Expand All @@ -319,10 +320,11 @@ int SonicDBConfig::getDbId(const std::string &dbName, const SonicDBKey &key)
return getDbInfo(dbName, key).dbId;
}

string SonicDBConfig::getSeparator(const string &dbName, const string &netns)
string SonicDBConfig::getSeparator(const string &dbName, const string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getSeparator(dbName, key);
}

Expand All @@ -331,10 +333,11 @@ string SonicDBConfig::getSeparator(const std::string &dbName, const SonicDBKey &
return getDbInfo(dbName, key).separator;
}

string SonicDBConfig::getSeparator(int dbId, const string &netns)
string SonicDBConfig::getSeparator(int dbId, const string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getSeparator(dbId, key);
}

Expand Down Expand Up @@ -389,10 +392,11 @@ string SonicDBConfig::getSeparator(const DBConnector* db)
}
}

string SonicDBConfig::getDbSock(const string &dbName, const string &netns)
string SonicDBConfig::getDbSock(const string &dbName, const string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getDbSock(dbName, key);
}

Expand All @@ -401,10 +405,11 @@ string SonicDBConfig::SonicDBConfig::getDbSock(const string &dbName, const Sonic
return getRedisInfo(dbName, key).unixSocketPath;
}

string SonicDBConfig::getDbHostname(const string &dbName, const string &netns)
string SonicDBConfig::getDbHostname(const string &dbName, const string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getDbHostname(dbName, key);
}

Expand All @@ -413,10 +418,11 @@ string SonicDBConfig::getDbHostname(const string &dbName, const SonicDBKey &key)
return getRedisInfo(dbName, key).hostname;
}

int SonicDBConfig::getDbPort(const string &dbName, const string &netns)
int SonicDBConfig::getDbPort(const string &dbName, const string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getDbPort(dbName, key);
}

Expand All @@ -441,10 +447,11 @@ vector<string> SonicDBConfig::getNamespaces()
return vector<string>(list.begin(), list.end());
}

std::vector<std::string> SonicDBConfig::getDbList(const std::string &netns)
std::vector<std::string> SonicDBConfig::getDbList(const std::string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getDbList(key);
}

Expand All @@ -465,10 +472,11 @@ std::vector<std::string> SonicDBConfig::getDbList(const SonicDBKey &key)
return dbNames;
}

map<string, RedisInstInfo> SonicDBConfig::getInstanceList(const std::string &netns)
map<string, RedisInstInfo> SonicDBConfig::getInstanceList(const std::string &netns, const std::string &containerName)
{
SonicDBKey key;
key.netns = netns;
key.containerName = containerName;
return getInstanceList(key);
}

Expand Down Expand Up @@ -665,7 +673,7 @@ DBConnector::DBConnector(const string& dbName, unsigned int timeout, bool isTcpC
}

DBConnector::DBConnector(const string& dbName, unsigned int timeout, bool isTcpConn)
: DBConnector(dbName, timeout, isTcpConn, EMPTY_SONIC_DB_KEY)
: DBConnector(dbName, timeout, isTcpConn, SonicDBKey())
{
// Empty constructor
}
Expand Down
39 changes: 19 additions & 20 deletions common/dbconnector.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
#include "rediscommand.h"
#include "redisreply.h"
#define EMPTY_NAMESPACE std::string()
#define EMPTY_CONTAINERNAME std::string()

namespace swss {

Expand Down Expand Up @@ -83,8 +84,6 @@ struct SonicDBKeyHash
}
};

extern const SonicDBKey EMPTY_SONIC_DB_KEY;

class SonicDBConfig
{
public:
Expand Down Expand Up @@ -112,21 +111,21 @@ class SonicDBConfig
static void reset();

static void validateNamespace(const std::string &netns);
static std::string getDbInst(const std::string &dbName, const std::string &netns);
static std::string getDbInst(const std::string &dbName, const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static int getDbId(const std::string &dbName, const std::string &netns);
static int getDbId(const std::string &dbName, const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static std::string getSeparator(const std::string &dbName, const std::string &netns);
static std::string getSeparator(const std::string &dbName, const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static std::string getSeparator(int dbId, const std::string &netns);
static std::string getSeparator(int dbId, const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static std::string getDbInst(const std::string &dbName, const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static std::string getDbInst(const std::string &dbName, const SonicDBKey &key);
static int getDbId(const std::string &dbName, const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static int getDbId(const std::string &dbName, const SonicDBKey &key);
static std::string getSeparator(const std::string &dbName, const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static std::string getSeparator(const std::string &dbName, const SonicDBKey &key);
static std::string getSeparator(int dbId, const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static std::string getSeparator(int dbId, const SonicDBKey &key);
static std::string getSeparator(const DBConnector* db);
static std::string getDbSock(const std::string &dbName, const std::string &netns);
static std::string getDbSock(const std::string &dbName, const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static std::string getDbHostname(const std::string &dbName, const std::string &netns);
static std::string getDbHostname(const std::string &dbName, const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static int getDbPort(const std::string &dbName, const std::string &netns);
static int getDbPort(const std::string &dbName, const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static std::string getDbSock(const std::string &dbName, const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static std::string getDbSock(const std::string &dbName, const SonicDBKey &key);
static std::string getDbHostname(const std::string &dbName, const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static std::string getDbHostname(const std::string &dbName, const SonicDBKey &key);
static int getDbPort(const std::string &dbName, const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static int getDbPort(const std::string &dbName, const SonicDBKey &key);
static std::vector<std::string> getNamespaces();
#if defined(SWIG) && defined(SWIGPYTHON)
%pythoncode %{
Expand All @@ -137,12 +136,12 @@ class SonicDBConfig
%}
#endif

static std::vector<std::string> getDbList(const std::string &netns);
static std::vector<std::string> getDbList(const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static std::vector<std::string> getDbList(const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static std::vector<std::string> getDbList(const SonicDBKey &key);
static bool isInit() { return m_init; };
static bool isGlobalInit() { return m_global_init; };
static std::map<std::string, RedisInstInfo> getInstanceList(const std::string &netns);
static std::map<std::string, RedisInstInfo> getInstanceList(const SonicDBKey &key = EMPTY_SONIC_DB_KEY);
static std::map<std::string, RedisInstInfo> getInstanceList(const std::string &netns = EMPTY_NAMESPACE, const std::string &containerName=EMPTY_CONTAINERNAME);
static std::map<std::string, RedisInstInfo> getInstanceList(const SonicDBKey &key);

private:
static std::recursive_mutex m_db_info_mutex;
Expand Down

0 comments on commit bb4f1df

Please sign in to comment.