CROSS_PROBE_CLIENT Class Reference

Routes cross-probe messages between standalone KiCad instances over the IPC API. More...

#include <cross_probe_client.h>

Static Public Member Functions
static bool	SendToFrame (FRAME_T aTarget, const google::protobuf::Message &aRequest)
static void	AnnounceToPrimary (FRAME_T aFrameType)
static void	RegisterPeer (FRAME_T aFrameType, const std::string &aSocketPath)
static bool	IsOnStandardSocketPath ()

Static Private Attributes
static std::mutex	s_mutex
static std::map< FRAME_T, std::string >	s_peers

Detailed Description

Routes cross-probe messages between standalone KiCad instances over the IPC API.

Can be removed once we remove standalone mode.

Definition at line 37 of file cross_probe_client.h.

Member Function Documentation

AnnounceToPrimary()

void CROSS_PROBE_CLIENT::AnnounceToPrimary ( FRAME_T aFrameType )

static

Definition at line 83 of file cross_probe_client.cpp.

References KICAD_API_CLIENT::Connect(), PGM_BASE::GetApiServer(), Pgm(), KICAD_API_SERVER::Running(), sendRequest(), KICAD_API_SERVER::SocketPath(), KICAD_API_SERVER::StandardSocketUrl(), KICAD_API_SERVER::Token(), and traceApi.

Referenced by PCB::IFACE::CreateKiWindow(), and SCH::IFACE::CreateKiWindow().

IsOnStandardSocketPath()

bool CROSS_PROBE_CLIENT::IsOnStandardSocketPath ( )

static

Definition at line 128 of file cross_probe_client.cpp.

References PGM_BASE::GetApiServer(), Pgm(), KICAD_API_SERVER::Running(), KICAD_API_SERVER::SocketPath(), and KICAD_API_SERVER::StandardSocketUrl().

Referenced by PCB::IFACE::CreateKiWindow(), and SCH::IFACE::CreateKiWindow().

RegisterPeer()

void CROSS_PROBE_CLIENT::RegisterPeer ( FRAME_T aFrameType, const std::string & aSocketPath )

static

Definition at line 121 of file cross_probe_client.cpp.

References s_mutex, and s_peers.

Referenced by API_HANDLER_PCB::handleCrossProbeAnnounce(), and API_HANDLER_SCH::handleCrossProbeAnnounce().

SendToFrame()

bool CROSS_PROBE_CLIENT::SendToFrame ( FRAME_T aTarget, const google::protobuf::Message & aRequest )

static

Definition at line 60 of file cross_probe_client.cpp.

References PGM_BASE::GetApiServer(), Pgm(), KICAD_API_SERVER::Running(), s_mutex, s_peers, sendRequest(), KICAD_API_SERVER::SocketPath(), and KICAD_API_SERVER::StandardSocketUrl().

Referenced by CVPCB_MAINFRAME::SendComponentSelectionToSch(), PCB_EDIT_FRAME::SendCrossProbeItem(), PCB_EDIT_FRAME::SendCrossProbeNetName(), sendHighlightNets(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), and PCB_EDIT_FRAME::SendSelectItemsToSch().

Member Data Documentation

s_mutex

std::mutex CROSS_PROBE_CLIENT::s_mutex

staticprivate

Definition at line 49 of file cross_probe_client.h.

Referenced by RegisterPeer(), and SendToFrame().

s_peers

std::map< FRAME_T, std::string > CROSS_PROBE_CLIENT::s_peers

staticprivate

Definition at line 50 of file cross_probe_client.h.

Referenced by RegisterPeer(), and SendToFrame().

---

The documentation for this class was generated from the following files:

• cross_probe_client.h
• cross_probe_client.cpp