Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-21 01:01:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ntcore] Pass pub/sub options as a unified PubSubOptions struct (#4794)

Browse Source 
In Java, PubSubOption is still used for passing options, but this
simplifies C++ use substantially, as it allows aggregate construction.
This commit is contained in:
Peter Johnson
2022-12-12 19:28:15 -08:00
committed by GitHub
parent f66a667321
commit a865f48e96
53 changed files with 695 additions and 623 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
ntcore/src/main/native/cpp/net/ClientImpl.cpp
View File

@@ -38,7 +38,7 @@ namespace {
struct PublisherData {
NT_Publisher handle;
PubSubOptions options;
PubSubOptionsImpl options;
// in options as double, but copy here as integer; rounded to the nearest
// 10 ms
uint32_t periodMs;
@@ -67,7 +67,7 @@ class CImpl : public ServerMessageHandler {
void Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
std::string_view name, std::string_view typeStr,
const wpi::json& properties, const PubSubOptions& options);
const wpi::json& properties, const PubSubOptionsImpl& options);
bool Unpublish(NT_Publisher pubHandle, NT_Topic topicHandle);
void SetValue(NT_Publisher pubHandle, const Value& value);
@@ -282,7 +282,8 @@ bool CImpl::CheckNetworkReady() {
void CImpl::Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
std::string_view name, std::string_view typeStr,
const wpi::json& properties, const PubSubOptions& options) {
const wpi::json& properties,
const PubSubOptionsImpl& options) {
unsigned int index = Handle{pubHandle}.GetIndex();
if (index >= m_publishers.size()) {
m_publishers.resize(index + 1);
@@ -445,7 +446,7 @@ ClientStartup::~ClientStartup() {
void ClientStartup::Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
std::string_view name, std::string_view typeStr,
const wpi::json& properties,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
WPI_DEBUG4(m_client.m_impl->m_logger, "StartupPublish({}, {}, {}, {})",
pubHandle, topicHandle, name, typeStr);
m_client.m_impl->Publish(pubHandle, topicHandle, name, typeStr, properties,
@@ -456,7 +457,7 @@ void ClientStartup::Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
void ClientStartup::Subscribe(NT_Subscriber subHandle,
std::span<const std::string> prefixes,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
WPI_DEBUG4(m_client.m_impl->m_logger, "StartupSubscribe({})", subHandle);
WireEncodeSubscribe(m_textWriter.Add(), Handle{subHandle}.GetIndex(),
prefixes, options);

7
ntcore/src/main/native/cpp/net/ClientImpl.h
View File

@@ -21,7 +21,7 @@ class Logger;
} // namespace wpi
namespace nt {
class PubSubOptions;
class PubSubOptionsImpl;
class Value;
} // namespace nt
@@ -64,9 +64,10 @@ class ClientStartup final : public NetworkStartupInterface {
// NetworkStartupInterface interface
void Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
std::string_view name, std::string_view typeStr,
const wpi::json& properties, const PubSubOptions& options) final;
const wpi::json& properties,
const PubSubOptionsImpl& options) final;
void Subscribe(NT_Subscriber subHandle, std::span<const std::string> prefixes,
const PubSubOptions& options) final;
const PubSubOptionsImpl& options) final;
void SetValue(NT_Publisher pubHandle, const Value& value) final;
private:

4
ntcore/src/main/native/cpp/net/Message.h
View File

@@ -24,7 +24,7 @@ struct PublishMsg {
std::string name;
std::string typeStr;
wpi::json properties;
PubSubOptions options; // will be empty when coming from network
PubSubOptionsImpl options; // will be empty when coming from network
};
struct UnpublishMsg {
@@ -44,7 +44,7 @@ struct SubscribeMsg {
static constexpr std::string_view kMethodStr = "subscribe";
NT_Subscriber subHandle{0};
std::vector<std::string> topicNames;
PubSubOptions options;
PubSubOptionsImpl options;
};
struct UnsubscribeMsg {

6
ntcore/src/main/native/cpp/net/NetworkInterface.h
View File

@@ -15,7 +15,7 @@ class json;
} // namespace wpi
namespace nt {
class PubSubOptions;
class PubSubOptionsImpl;
class Value;
} // namespace nt
@@ -42,10 +42,10 @@ class NetworkStartupInterface {
virtual void Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
std::string_view name, std::string_view typeStr,
const wpi::json& properties,
const PubSubOptions& options) = 0;
const PubSubOptionsImpl& options) = 0;
virtual void Subscribe(NT_Subscriber subHandle,
std::span<const std::string> topicNames,
const PubSubOptions& options) = 0;
const PubSubOptionsImpl& options) = 0;
virtual void SetValue(NT_Publisher pubHandle, const Value& value) = 0;
};

5
ntcore/src/main/native/cpp/net/NetworkLoopQueue.h
View File

@@ -33,13 +33,14 @@ class NetworkLoopQueue : public NetworkInterface {
// NetworkInterface - calls to these append to the queue
void Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
std::string_view name, std::string_view typeStr,
const wpi::json& properties, const PubSubOptions& options) final;
const wpi::json& properties,
const PubSubOptionsImpl& options) final;
void Unpublish(NT_Publisher pubHandle, NT_Topic topicHandle) final;
void SetProperties(NT_Topic topicHandle, std::string_view name,
const wpi::json& update) final;
void Subscribe(NT_Subscriber subHandle,
std::span<const std::string> topicNames,
const PubSubOptions& options) final;
const PubSubOptionsImpl& options) final;
void Unsubscribe(NT_Subscriber subHandle) final;
void SetValue(NT_Publisher pubHandle, const Value& value) final;

4
ntcore/src/main/native/cpp/net/NetworkLoopQueue.inc
View File

@@ -34,7 +34,7 @@ inline void NetworkLoopQueue::Publish(NT_Publisher pubHandle,
std::string_view name,
std::string_view typeStr,
const wpi::json& properties,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
std::scoped_lock lock{m_mutex};
m_queue.emplace_back(
ClientMessage{PublishMsg{pubHandle, topicHandle, std::string{name},
@@ -57,7 +57,7 @@ inline void NetworkLoopQueue::SetProperties(NT_Topic topicHandle,
inline void NetworkLoopQueue::Subscribe(NT_Subscriber subHandle,
std::span<const std::string> topicNames,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
std::scoped_lock lock{m_mutex};
m_queue.emplace_back(ClientMessage{SubscribeMsg{
subHandle, {topicNames.begin(), topicNames.end()}, options}});

25
ntcore/src/main/native/cpp/net/ServerImpl.cpp
View File

@@ -159,7 +159,7 @@ class ClientData4Base : public ClientData, protected ClientMessageHandler {
void ClientSetProperties(std::string_view name,
const wpi::json& update) final;
void ClientSubscribe(int64_t subuid, std::span<const std::string> topicNames,
const PubSubOptions& options) final;
const PubSubOptionsImpl& options) final;
void ClientUnsubscribe(int64_t subuid) final;
void ClientSetValue(int64_t pubuid, const Value& value);
@@ -362,7 +362,7 @@ struct PublisherData {
struct SubscriberData {
SubscriberData(ClientData* client, std::span<const std::string> topicNames,
int64_t subuid, const PubSubOptions& options)
int64_t subuid, const PubSubOptionsImpl& options)
: client{client},
topicNames{topicNames.begin(), topicNames.end()},
subuid{subuid},
@@ -374,7 +374,7 @@ struct SubscriberData {
}
void Update(std::span<const std::string> topicNames_,
const PubSubOptions& options_) {
const PubSubOptionsImpl& options_) {
topicNames = {topicNames_.begin(), topicNames_.end()};
options = options_;
periodMs = std::lround(options_.periodicMs / 10.0) * 10;
@@ -388,7 +388,7 @@ struct SubscriberData {
ClientData* client;
std::vector<std::string> topicNames;
int64_t subuid;
PubSubOptions options;
PubSubOptionsImpl options;
// in options as double, but copy here as integer; rounded to the nearest
// 10 ms
uint32_t periodMs;
@@ -463,10 +463,11 @@ struct Writer : public mpack_writer_t {
};
} // namespace
static void WriteOptions(mpack_writer_t& w, const PubSubOptions& options) {
int size = (options.sendAll ? 1 : 0) + (options.topicsOnly ? 1 : 0) +
(options.periodicMs != PubSubOptions::kDefaultPeriodicMs ? 1 : 0) +
(options.prefixMatch ? 1 : 0);
static void WriteOptions(mpack_writer_t& w, const PubSubOptionsImpl& options) {
int size =
(options.sendAll ? 1 : 0) + (options.topicsOnly ? 1 : 0) +
(options.periodicMs != PubSubOptionsImpl::kDefaultPeriodicMs ? 1 : 0) +
(options.prefixMatch ? 1 : 0);
mpack_start_map(&w, size);
if (options.sendAll) {
mpack_write_str(&w, "all");
@@ -476,7 +477,7 @@ static void WriteOptions(mpack_writer_t& w, const PubSubOptions& options) {
mpack_write_str(&w, "topicsonly");
mpack_write_bool(&w, true);
}
if (options.periodicMs != PubSubOptions::kDefaultPeriodicMs) {
if (options.periodicMs != PubSubOptionsImpl::kDefaultPeriodicMs) {
mpack_write_str(&w, "periodic");
mpack_write_float(&w, options.periodicMs / 1000.0);
}
@@ -616,7 +617,7 @@ void ClientData4Base::ClientSetProperties(std::string_view name,
void ClientData4Base::ClientSubscribe(int64_t subuid,
std::span<const std::string> topicNames,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
DEBUG4("ClientSubscribe({}, ({}), {})", m_id, fmt::join(topicNames, ","),
subuid);
auto& sub = m_subscribers[subuid];
@@ -2365,14 +2366,14 @@ std::string ServerImpl::LoadPersistent(std::string_view in) {
void ServerStartup::Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
std::string_view name, std::string_view typeStr,
const wpi::json& properties,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
m_server.m_impl->m_localClient->ClientPublish(pubHandle, name, typeStr,
properties);
}
void ServerStartup::Subscribe(NT_Subscriber subHandle,
std::span<const std::string> topicNames,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
m_server.m_impl->m_localClient->ClientSubscribe(subHandle, topicNames,
options);
}

5
ntcore/src/main/native/cpp/net/ServerImpl.h
View File

@@ -83,10 +83,11 @@ class ServerStartup final : public NetworkStartupInterface {
// NetworkStartupInterface interface
void Publish(NT_Publisher pubHandle, NT_Topic topicHandle,
std::string_view name, std::string_view typeStr,
const wpi::json& properties, const PubSubOptions& options) final;
const wpi::json& properties,
const PubSubOptionsImpl& options) final;
void Subscribe(NT_Subscriber subHandle,
std::span<const std::string> topicNames,
const PubSubOptions& options) final;
const PubSubOptionsImpl& options) final;
void SetValue(NT_Publisher pubHandle, const Value& value) final;
private:

3
ntcore/src/main/native/cpp/net/WireDecoder.cpp
View File

@@ -226,7 +226,7 @@ static void WireDecodeTextImpl(std::string_view in, T& out,
}
// options
PubSubOptions options;
PubSubOptionsImpl options;
auto optionsIt = params->find("options");
if (optionsIt != params->end()) {
auto joptions = optionsIt->second.get_ptr<wpi::json::object_t*>();
@@ -243,6 +243,7 @@ static void WireDecodeTextImpl(std::string_view in, T& out,
error = "periodic value must be a number";
goto err;
}
options.periodic = val;
options.periodicMs = val * 1000;
}

4
ntcore/src/main/native/cpp/net/WireDecoder.h
View File

@@ -17,7 +17,7 @@ class json;
} // namespace wpi
namespace nt {
class PubSubOptions;
class PubSubOptionsImpl;
class Value;
} // namespace nt
@@ -35,7 +35,7 @@ class ClientMessageHandler {
const wpi::json& update) = 0;
virtual void ClientSubscribe(int64_t subuid,
std::span<const std::string> topicNames,
const PubSubOptions& options) = 0;
const PubSubOptionsImpl& options) = 0;
virtual void ClientUnsubscribe(int64_t subuid) = 0;
};

8
ntcore/src/main/native/cpp/net/WireEncoder.cpp
View File

@@ -76,7 +76,7 @@ static void EncodePrefixes(wpi::raw_ostream& os, std::span<const T> topicNames,
template <typename T>
static void WireEncodeSubscribeImpl(wpi::raw_ostream& os, int64_t subuid,
std::span<const T> topicNames,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
wpi::json::serializer s{os, ' ', 0};
os << "{\"method\":\"" << SubscribeMsg::kMethodStr << "\",\"params\":{";
os << "\"options\":{";
@@ -99,7 +99,7 @@ static void WireEncodeSubscribeImpl(wpi::raw_ostream& os, int64_t subuid,
os << "\"prefix\":true";
first = false;
}
if (options.periodicMs != PubSubOptions::kDefaultPeriodicMs) {
if (options.periodicMs != PubSubOptionsImpl::kDefaultPeriodicMs) {
if (!first) {
os << ',';
}
@@ -115,13 +115,13 @@ static void WireEncodeSubscribeImpl(wpi::raw_ostream& os, int64_t subuid,
void nt::net::WireEncodeSubscribe(wpi::raw_ostream& os, int64_t subuid,
std::span<const std::string_view> topicNames,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
WireEncodeSubscribeImpl(os, subuid, topicNames, options);
}
void nt::net::WireEncodeSubscribe(wpi::raw_ostream& os, int64_t subuid,
std::span<const std::string> topicNames,
const PubSubOptions& options) {
const PubSubOptionsImpl& options) {
WireEncodeSubscribeImpl(os, subuid, topicNames, options);
}

6
ntcore/src/main/native/cpp/net/WireEncoder.h
View File

@@ -15,7 +15,7 @@ class raw_ostream;
} // namespace wpi
namespace nt {
class PubSubOptions;
class PubSubOptionsImpl;
class Value;
} // namespace nt
@@ -33,10 +33,10 @@ void WireEncodeSetProperties(wpi::raw_ostream& os, std::string_view name,
const wpi::json& update);
void WireEncodeSubscribe(wpi::raw_ostream& os, int64_t subuid,
std::span<const std::string_view> topicNames,
const PubSubOptions& options);
const PubSubOptionsImpl& options);
void WireEncodeSubscribe(wpi::raw_ostream& os, int64_t subuid,
std::span<const std::string> topicNames,
const PubSubOptions& options);
const PubSubOptionsImpl& options);
void WireEncodeUnsubscribe(wpi::raw_ostream& os, int64_t subuid);
// encoders for server text messages (avoids need to construct a Message struct)