protocol.hpp File Reference

#include <cstddef>
#include <cstdint>
#include <string>
#include <string_view>
#include <pulp/inspect/protocol_methods.inc>

Go to the source code of this file.

Classes
struct	pulp::inspect::InspectorMessage
	A single inspector protocol message (request, response, or event). More...

Namespaces
namespace	pulp
namespace	pulp::inspect
namespace	pulp::inspect::methods

Macros
#define	PULP_INSPECT_METHOD(symbol, wire_name, capability, kind)

Functions
std::string	pulp::inspect::encode_message (const InspectorMessage &msg)
	Serialize a message to a JSON string.
bool	pulp::inspect::decode_message (const std::string &json, InspectorMessage &out)
	Parse a JSON string into a message. Returns false on parse failure.
InspectorMessage	pulp::inspect::make_request (int64_t id, std::string method, std::string params_json="{}")
InspectorMessage	pulp::inspect::make_response (int64_t id, std::string result_json)
InspectorMessage	pulp::inspect::make_error (int64_t id, std::string error_message, std::string error_code="internal_error", std::string error_data_json="{}")
InspectorMessage	pulp::inspect::make_event (std::string method, std::string params_json="{}")

Variables
constexpr std::size_t	pulp::inspect::kInspectorExtendedMessageBytes
	Bounded transfer ceiling used by clients and by hosts that expose image capture.
constexpr auto	pulp::inspect::methods::kSessionGetCapabilities = "Session.getCapabilities"
constexpr auto	pulp::inspect::methods::kSessionAuthenticate = "Session.authenticate"
constexpr auto	pulp::inspect::methods::kSessionAuthChallenge = "Session.authChallenge"
constexpr auto	pulp::inspect::methods::kSessionAcquireController = "Session.acquireController"
constexpr auto	pulp::inspect::methods::kSessionRenewController = "Session.renewController"
constexpr auto	pulp::inspect::methods::kSessionReleaseController = "Session.releaseController"
constexpr auto	pulp::inspect::methods::kInspectorEnable = "Inspector.enable"
constexpr auto	pulp::inspect::methods::kInspectorDisable = "Inspector.disable"
constexpr auto	pulp::inspect::methods::kInspectorGetInfo = "Inspector.getInfo"
constexpr auto	pulp::inspect::methods::kInspectorGetAgentContext = "Inspector.getAgentContext"
constexpr auto	pulp::inspect::methods::kInspectorApplyTweak = "Inspector.applyTweak"
constexpr auto	pulp::inspect::methods::kInspectorListTweaks = "Inspector.listTweaks"
constexpr auto	pulp::inspect::methods::kInspectorClearTweaks = "Inspector.clearTweaks"
constexpr auto	pulp::inspect::methods::kInspectorSetBypass = "Inspector.setBypass"
constexpr auto	pulp::inspect::methods::kInspectorSetLocked = "Inspector.setLocked"
constexpr auto	pulp::inspect::methods::kInspectorLoadTweaks = "Inspector.loadTweaks"
constexpr auto	pulp::inspect::methods::kInspectorSaveTweaks = "Inspector.saveTweaks"
constexpr auto	pulp::inspect::methods::kInspectorSetAutoSave = "Inspector.setAutoSave"
constexpr auto	pulp::inspect::methods::kInspectorSetEditorUrlTemplate = "Inspector.setEditorUrlTemplate"
constexpr auto	pulp::inspect::methods::kInspectorGetEditorUrlTemplate = "Inspector.getEditorUrlTemplate"
constexpr auto	pulp::inspect::methods::kInspectorJumpToSource = "Inspector.jumpToSource"
constexpr auto	pulp::inspect::methods::kDOMGetDocument = "DOM.getDocument"
constexpr auto	pulp::inspect::methods::kDOMGetNodeById = "DOM.getNodeById"
constexpr auto	pulp::inspect::methods::kDOMHighlightNode = "DOM.highlightNode"
constexpr auto	pulp::inspect::methods::kDOMClearHighlight = "DOM.clearHighlight"
constexpr auto	pulp::inspect::methods::kDOMSearch = "DOM.search"
constexpr auto	pulp::inspect::methods::kDOMDocumentUpdated = "DOM.documentUpdated"
constexpr auto	pulp::inspect::methods::kCSSGetComputedStyle = "CSS.getComputedStyle"
constexpr auto	pulp::inspect::methods::kCSSGetTheme = "CSS.getTheme"
constexpr auto	pulp::inspect::methods::kCSSThemeChanged = "CSS.themeChanged"
constexpr auto	pulp::inspect::methods::kLiveConstList = "LiveConstant.list"
constexpr auto	pulp::inspect::methods::kLiveConstSet = "LiveConstant.set"
constexpr auto	pulp::inspect::methods::kLiveConstReset = "LiveConstant.reset"
constexpr auto	pulp::inspect::methods::kPerfGetMetrics = "Performance.getMetrics"
constexpr auto	pulp::inspect::methods::kPerfEnableTracking = "Performance.enableTracking"
constexpr auto	pulp::inspect::methods::kPerfMetrics = "Performance.metrics"
constexpr auto	pulp::inspect::methods::kPerfSetRepaintFlash = "Performance.setRepaintFlash"
constexpr auto	pulp::inspect::methods::kPerfGetRepaintFlash = "Performance.getRepaintFlash"
constexpr auto	pulp::inspect::methods::kStateGetParameters = "State.getParameters"
constexpr auto	pulp::inspect::methods::kStateSetParameter = "State.setParameter"
constexpr auto	pulp::inspect::methods::kStateGetValueChannels = "State.getValueChannels"
constexpr auto	pulp::inspect::methods::kStateParameterChanged = "State.parameterChanged"
constexpr auto	pulp::inspect::methods::kTelemetryGetSnapshot = "Telemetry.getSnapshot"
constexpr auto	pulp::inspect::methods::kTelemetrySubscribe = "Telemetry.subscribe"
constexpr auto	pulp::inspect::methods::kTelemetryUnsubscribe = "Telemetry.unsubscribe"
constexpr auto	pulp::inspect::methods::kTelemetrySample = "Telemetry.sample"
constexpr auto	pulp::inspect::methods::kTestInjectMidi = "Test.injectMidi"
constexpr auto	pulp::inspect::methods::kTestSetTransport = "Test.setTransport"
constexpr auto	pulp::inspect::methods::kConsoleEnable = "Console.enable"
constexpr auto	pulp::inspect::methods::kConsoleGetMessages = "Console.getMessages"
constexpr auto	pulp::inspect::methods::kConsoleMessageAdded = "Console.messageAdded"
constexpr auto	pulp::inspect::methods::kRuntimeEvaluate = "Runtime.evaluate"
constexpr auto	pulp::inspect::methods::kRuntimeGetCapabilities = "Runtime.getCapabilities"
constexpr auto	pulp::inspect::methods::kRuntimeInterrupt = "Runtime.interrupt"
constexpr auto	pulp::inspect::methods::kRuntimeGetHotReloadStatus = "Runtime.getHotReloadStatus"
constexpr auto	pulp::inspect::methods::kRuntimeHotReloaded = "Runtime.hotReloaded"
constexpr auto	pulp::inspect::methods::kAudioGetConfig = "Audio.getConfig"
constexpr auto	pulp::inspect::methods::kAudioEnableMetering = "Audio.enableMetering"
constexpr auto	pulp::inspect::methods::kAudioGetMidiLog = "Audio.getMidiLog"
constexpr auto	pulp::inspect::methods::kAudioRuntimeTelemetry = "Audio.runtimeTelemetry"
constexpr auto	pulp::inspect::methods::kAudioBufferUnderrun = "Audio.bufferUnderrun"
constexpr auto	pulp::inspect::methods::kAudioLevels = "Audio.levels"
constexpr auto	pulp::inspect::methods::kCaptureScreenshot = "Capture.screenshot"
constexpr auto	pulp::inspect::methods::kCaptureScreenshotNode = "Capture.screenshotNode"
constexpr auto	pulp::inspect::methods::kRenderCaptureFrame = "Render.captureFrame"
constexpr auto	pulp::inspect::methods::kMotionStartTrace = "Motion.startTrace"
constexpr auto	pulp::inspect::methods::kMotionStopTrace = "Motion.stopTrace"
constexpr auto	pulp::inspect::methods::kMotionSnapshot = "Motion.snapshot"
constexpr auto	pulp::inspect::methods::kMotionListTraces = "Motion.listTraces"
constexpr auto	pulp::inspect::methods::kMotionLoadFixture = "Motion.loadFixture"
constexpr auto	pulp::inspect::methods::kMotionScrubTo = "Motion.scrubTo"
constexpr auto	pulp::inspect::methods::kMotionPlay = "Motion.play"
constexpr auto	pulp::inspect::methods::kMotionPause = "Motion.pause"
constexpr auto	pulp::inspect::methods::kMotionEnableCost = "Motion.enableCost"
constexpr auto	pulp::inspect::methods::kMotionDisableCost = "Motion.disableCost"
constexpr auto	pulp::inspect::methods::kMotionStart = "Motion.start"
constexpr auto	pulp::inspect::methods::kMotionSample = "Motion.sample"
constexpr auto	pulp::inspect::methods::kMotionEnd = "Motion.end"
constexpr auto	pulp::inspect::methods::kMotionCost = "Motion.cost"
constexpr auto	pulp::inspect::methods::kTraceStartSession = "Trace.startSession"
constexpr auto	pulp::inspect::methods::kTraceStopSession = "Trace.stopSession"
constexpr auto	pulp::inspect::methods::kTraceSnapshot = "Trace.snapshot"
constexpr auto	pulp::inspect::methods::kTraceQuery = "Trace.query"
constexpr auto	pulp::inspect::methods::kTraceExplain = "Trace.explain"

Macro Definition Documentation

PULP_INSPECT_METHOD

#define PULP_INSPECT_METHOD	(		symbol,
			wire_name,
			capability,
			kind )

Value:

    inline constexpr auto symbol = wire_name;