mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-20 00:51:42 +00:00
334 lines
9.0 KiB
C++
334 lines
9.0 KiB
C++
#ifndef _NETWORKTABLE_H_
|
|
#define _NETWORKTABLE_H_
|
|
|
|
#include <functional>
|
|
#include <mutex>
|
|
#include <vector>
|
|
|
|
#include "tables/ITable.h"
|
|
|
|
class NetworkTable : public ITable {
|
|
private:
|
|
struct private_init {};
|
|
|
|
std::string m_path;
|
|
std::mutex m_mutex;
|
|
typedef std::pair<ITableListener*, unsigned int> Listener;
|
|
std::vector<Listener> m_listeners;
|
|
|
|
static std::string s_ip_address;
|
|
static std::string s_persistent_filename;
|
|
static bool s_client;
|
|
static bool s_running;
|
|
static unsigned int s_port;
|
|
|
|
public:
|
|
NetworkTable(llvm::StringRef path, const private_init&);
|
|
virtual ~NetworkTable();
|
|
|
|
/**
|
|
* The path separator for sub-tables and keys
|
|
*
|
|
*/
|
|
static const char PATH_SEPARATOR_CHAR;
|
|
|
|
/**
|
|
* @throws IOException
|
|
*/
|
|
static void Initialize();
|
|
static void Shutdown();
|
|
|
|
/**
|
|
* set that network tables should be a client
|
|
* This must be called before initialize or GetTable
|
|
*/
|
|
static void SetClientMode();
|
|
|
|
/**
|
|
* set that network tables should be a server
|
|
* This must be called before initialize or GetTable
|
|
*/
|
|
static void SetServerMode();
|
|
|
|
/**
|
|
* set the team the robot is configured for (this will set the mdns address that
|
|
* network tables will connect to in client mode)
|
|
* This must be called before initialize or GetTable
|
|
* @param team the team number
|
|
*/
|
|
static void SetTeam(int team);
|
|
|
|
/**
|
|
* @param address the adress that network tables will connect to in client
|
|
* mode
|
|
*/
|
|
static void SetIPAddress(llvm::StringRef address);
|
|
|
|
/**
|
|
* @param port the port number that network tables will connect to in client
|
|
* mode or listen to in server mode
|
|
*/
|
|
static void SetPort(unsigned int port);
|
|
|
|
/**
|
|
* Sets the persistent filename.
|
|
* @param filename the filename that the network tables server uses for
|
|
* automatic loading and saving of persistent values
|
|
*/
|
|
static void SetPersistentFilename(llvm::StringRef filename);
|
|
|
|
/**
|
|
* Sets the network identity.
|
|
* This is provided in the connection info on the remote end.
|
|
* @param name identity
|
|
*/
|
|
static void SetNetworkIdentity(llvm::StringRef name);
|
|
|
|
/**
|
|
* Deletes ALL keys in ALL subtables. Use with caution!
|
|
*/
|
|
static void GlobalDeleteAll();
|
|
|
|
/**
|
|
* Flushes all updated values immediately to the network.
|
|
* Note: This is rate-limited to protect the network from flooding.
|
|
* This is primarily useful for synchronizing network updates with
|
|
* user code.
|
|
*/
|
|
static void Flush();
|
|
|
|
/**
|
|
* Set the periodic update rate.
|
|
*
|
|
* @param interval update interval in seconds (range 0.1 to 1.0)
|
|
*/
|
|
static void SetUpdateRate(double interval);
|
|
|
|
/**
|
|
* Saves persistent keys to a file. The server does this automatically.
|
|
*
|
|
* @param filename file name
|
|
* @return Error (or nullptr).
|
|
*/
|
|
static const char* SavePersistent(llvm::StringRef filename);
|
|
|
|
/**
|
|
* Loads persistent keys from a file. The server does this automatically.
|
|
*
|
|
* @param filename file name
|
|
* @param warn callback function called for warnings
|
|
* @return Error (or nullptr).
|
|
*/
|
|
static const char* LoadPersistent(
|
|
llvm::StringRef filename,
|
|
std::function<void(size_t line, const char* msg)> warn);
|
|
|
|
/**
|
|
* Gets the table with the specified key. If the table does not exist, a new
|
|
*table will be created.<br>
|
|
* This will automatically initialize network tables if it has not been
|
|
*already
|
|
*
|
|
* @param key
|
|
* the key name
|
|
* @return the network table requested
|
|
*/
|
|
static std::shared_ptr<NetworkTable> GetTable(llvm::StringRef key);
|
|
|
|
void AddTableListener(ITableListener* listener);
|
|
void AddTableListener(ITableListener* listener, bool immediateNotify);
|
|
void AddTableListenerEx(ITableListener* listener, unsigned int flags);
|
|
void AddTableListener(llvm::StringRef key, ITableListener* listener,
|
|
bool immediateNotify);
|
|
void AddTableListenerEx(llvm::StringRef key, ITableListener* listener,
|
|
unsigned int flags);
|
|
void AddSubTableListener(ITableListener* listener);
|
|
void AddSubTableListener(ITableListener* listener, bool localNotify);
|
|
void RemoveTableListener(ITableListener* listener);
|
|
|
|
/**
|
|
* Returns the table at the specified key. If there is no table at the
|
|
* specified key, it will create a new table
|
|
*
|
|
* @param key
|
|
* the key name
|
|
* @return the networktable to be returned
|
|
*/
|
|
std::shared_ptr<ITable> GetSubTable(llvm::StringRef key) const;
|
|
|
|
/**
|
|
* Checks the table and tells if it contains the specified key
|
|
*
|
|
* @param key
|
|
* the key to be checked
|
|
*/
|
|
bool ContainsKey(llvm::StringRef key) const;
|
|
|
|
bool ContainsSubTable(llvm::StringRef key) const;
|
|
|
|
/**
|
|
* @param types bitmask of types; 0 is treated as a "don't care".
|
|
* @return keys currently in the table
|
|
*/
|
|
std::vector<std::string> GetKeys(int types = 0) const;
|
|
|
|
/**
|
|
* @return subtables currently in the table
|
|
*/
|
|
std::vector<std::string> GetSubTables() const;
|
|
|
|
/**
|
|
* Makes a key's value persistent through program restarts.
|
|
*
|
|
* @param key the key to make persistent
|
|
*/
|
|
void SetPersistent(llvm::StringRef key);
|
|
|
|
/**
|
|
* Stop making a key's value persistent through program restarts.
|
|
* The key cannot be null.
|
|
*
|
|
* @param key the key name
|
|
*/
|
|
void ClearPersistent(llvm::StringRef key);
|
|
|
|
/**
|
|
* Returns whether the value is persistent through program restarts.
|
|
* The key cannot be null.
|
|
*
|
|
* @param key the key name
|
|
*/
|
|
bool IsPersistent(llvm::StringRef key);
|
|
|
|
/**
|
|
* Sets flags on the specified key in this table. The key can
|
|
* not be null.
|
|
*
|
|
* @param key the key name
|
|
* @param flags the flags to set (bitmask)
|
|
*/
|
|
void SetFlags(llvm::StringRef key, unsigned int flags);
|
|
|
|
/**
|
|
* Clears flags on the specified key in this table. The key can
|
|
* not be null.
|
|
*
|
|
* @param key the key name
|
|
* @param flags the flags to clear (bitmask)
|
|
*/
|
|
void ClearFlags(llvm::StringRef key, unsigned int flags);
|
|
|
|
/**
|
|
* Returns the flags for the specified key.
|
|
*
|
|
* @param key
|
|
* the key name
|
|
* @return the flags, or 0 if the key is not defined
|
|
*/
|
|
unsigned int GetFlags(llvm::StringRef key);
|
|
|
|
/**
|
|
* Deletes the specified key in this table. The key can
|
|
* not be null.
|
|
*
|
|
* @param key the key name
|
|
*/
|
|
void Delete(llvm::StringRef key);
|
|
|
|
/**
|
|
* Maps the specified key to the specified value in this table. The key can
|
|
* not be null. The value can be retrieved by calling the get method with a
|
|
* key that is equal to the original key.
|
|
*
|
|
* @param key
|
|
* the key
|
|
* @param value
|
|
* the value
|
|
*/
|
|
bool PutNumber(llvm::StringRef key, double value);
|
|
|
|
/**
|
|
* Returns the key that the name maps to. If the key is null, it will return
|
|
* the default value
|
|
*
|
|
* @param key
|
|
* the key name
|
|
* @param defaultValue
|
|
* the default value if the key is null
|
|
* @return the key
|
|
*/
|
|
double GetNumber(llvm::StringRef key, double defaultValue) const;
|
|
|
|
/**
|
|
* Maps the specified key to the specified value in this table. The key can
|
|
* not be null. The value can be retrieved by calling the get method with a
|
|
* key that is equal to the original key.
|
|
*
|
|
* @param key
|
|
* the key
|
|
* @param value
|
|
* the value
|
|
*/
|
|
bool PutString(llvm::StringRef key, llvm::StringRef value);
|
|
|
|
/**
|
|
* Returns the key that the name maps to. If the key is null, it will return
|
|
* the default value
|
|
*
|
|
* @param key
|
|
* the key name
|
|
* @param defaultValue
|
|
* the default value if the key is null
|
|
* @return the key
|
|
*/
|
|
std::string GetString(llvm::StringRef key,
|
|
llvm::StringRef defaultValue) const;
|
|
|
|
/**
|
|
* Maps the specified key to the specified value in this table. The key can
|
|
* not be null. The value can be retrieved by calling the get method with a
|
|
* key that is equal to the original key.
|
|
*
|
|
* @param key
|
|
* the key
|
|
* @param value
|
|
* the value
|
|
*/
|
|
bool PutBoolean(llvm::StringRef key, bool value);
|
|
|
|
/**
|
|
* Returns the key that the name maps to. If the key is null, it will return
|
|
* the default value
|
|
*
|
|
* @param key
|
|
* the key name
|
|
* @param defaultValue
|
|
* the default value if the key is null
|
|
* @return the key
|
|
*/
|
|
bool GetBoolean(llvm::StringRef key, bool defaultValue) const;
|
|
|
|
/**
|
|
* Maps the specified key to the specified value in this table. The key can
|
|
* not be null. The value can be retrieved by calling the get method with a
|
|
* key that is equal to the original key.
|
|
*
|
|
* @param key the key name
|
|
* @param value the value to be put
|
|
*/
|
|
bool PutValue(llvm::StringRef key, std::shared_ptr<nt::Value> value);
|
|
|
|
/**
|
|
* Returns the key that the name maps to.
|
|
* NOTE: If the value is a double, it will return a Double object,
|
|
* not a primitive. To get the primitive, use GetDouble
|
|
*
|
|
* @param key
|
|
* the key name
|
|
* @return the key, or nullptr if the key is not defined
|
|
*/
|
|
std::shared_ptr<nt::Value> GetValue(llvm::StringRef key) const;
|
|
};
|
|
|
|
#endif
|