Table of Contents

Class RDCoreComponentProtocol

Namespace
RDCore.SDK.Platform.Components
Assembly
RDCore.SDK.dll

The names of the methods of the RDCore platform's own protocol (rdcore/) that the components of the platform send one another, and no client sends: the language server's to the environment host (rdcore/host/) and to the parser (rdcore/parser/*), and the environment host's to the language server.

public static class RDCoreComponentProtocol
Inheritance
RDCoreComponentProtocol
Inherited Members

Remarks

The component protocol is outside the SDK's compatibility promise: its methods and their types can change in any release. Only the platform's own processes speak it.

The methods a client sends or answers are RDCorePlatformProtocol's; the language server serves most of them with one of these. The method the language server sends a diagnostics provider is part of the extension contract (RDCoreExtensionProtocol).

Fields

DefineSymbols

Sends a module's member symbol descriptors to the environment host to define in its runtime session.

public const string DefineSymbols = "rdcore/host/symbols/define"

Field Value

string

HostDebugBreakpoints

Asks the environment host to set the lines of a module that a program under a debugger waits at. See SessionDebugBreakpoints.

public const string HostDebugBreakpoints = "rdcore/host/debug/breakpoints"

Field Value

string

HostDebugEditStatus

Asks the environment host which edits made while a program waits are not applied to it: what resuming it would be refused for. See SessionDebugEditStatus.

public const string HostDebugEditStatus = "rdcore/host/debug/editStatus"

Field Value

string

HostDebugErrorBreak

Asks the environment host to say which run-time errors a program under a debugger waits at, where they are raised.

public const string HostDebugErrorBreak = "rdcore/host/debug/errorBreak"

Field Value

string

HostDebugEvaluate

Asks the environment host for the value of an expression in an activation of the program that waits. See SessionDebugEvaluate.

public const string HostDebugEvaluate = "rdcore/host/debug/evaluate"

Field Value

string

HostDebugExecute

Asks the environment host to run a statement in an activation of the program that waits. See SessionDebugExecute.

public const string HostDebugExecute = "rdcore/host/debug/execute"

Field Value

string

HostDebugGoto

Asks the environment host to move the point a program that waits goes on from. See SessionDebugGoto.

public const string HostDebugGoto = "rdcore/host/debug/goto"

Field Value

string

HostDebugPause

Asks the environment host to stop a program that is running where it is, so that it waits. See SessionDebugPause.

public const string HostDebugPause = "rdcore/host/debug/pause"

Field Value

string

HostDebugResume

Asks the environment host to resume a program that waits at a stop, or to take one step of it. The language-server side of SessionDebugResume.

public const string HostDebugResume = "rdcore/host/debug/resume"

Field Value

string

HostDebugStack

Asks the environment host for the call stack of the program that waits. See SessionDebugStack.

public const string HostDebugStack = "rdcore/host/debug/stack"

Field Value

string

HostDebugStopped

Asks the language server whether a client takes a stop in the handler of an event that runs while no program runs: a request from the environment host, whose handler waits if one does. The language server tells its client with SessionDebugStopped.

public const string HostDebugStopped = "rdcore/host/debug/stopped"

Field Value

string

HostDebugTerminate

Asks the environment host to end a program that is running or waits. See SessionDebugTerminate.

public const string HostDebugTerminate = "rdcore/host/debug/terminate"

Field Value

string

HostDebugVariables

Asks the environment host for the variables of an activation of the program that waits. See SessionDebugVariables.

public const string HostDebugVariables = "rdcore/host/debug/variables"

Field Value

string

HostDiscard

Asks the environment host to take a module out of its runtime session. The language-server side of SessionDiscard.

public const string HostDiscard = "rdcore/host/discard"

Field Value

string

HostEntryPoints

Asks the environment host which modules of its runtime session declare a procedure a program can start with: what a debug adapter asks of a launch that names no module, before it runs one.

public const string HostEntryPoints = "rdcore/host/entryPoints"

Field Value

string

HostExecute

Asks the environment host to lower and run a parsed module in its runtime session. The language-server side of SessionExecute.

public const string HostExecute = "rdcore/host/execute"

Field Value

string

HostFormsUnloaded

Tells the language server that the session has no form loaded: a notification from the environment host, sent when the last loaded form is unloaded, or let go of, or ended with the rest of the session's state by an End.

public const string HostFormsUnloaded = "rdcore/host/forms/unloaded"

Field Value

string

HostInputBox

Asks the language server to have the client answer a program's InputBox. See HostMessageBox.

public const string HostInputBox = "rdcore/host/interaction/inputBox"

Field Value

string

HostMessageBox

Asks the language server to have the client answer a program's MsgBox: a request from the environment host, which waits for the answer as the program waits for the dialog. The language server asks the client with SessionMessageBox.

public const string HostMessageBox = "rdcore/host/interaction/msgBox"

Field Value

string

HostOutput

Tells the language server what a program printed, as it prints: a notification from the environment host, sent for a program that was run with its output streamed (HostExecuteParams.StreamOutput).

public const string HostOutput = "rdcore/host/output"

Field Value

string

HostPeek

Reads one byte of the environment host's runtime session memory. The language-server side of SessionPeek.

public const string HostPeek = "rdcore/host/memory/peek"

Field Value

string

HostPoke

Writes one byte of the environment host's runtime session memory. The language-server side of SessionPoke.

public const string HostPoke = "rdcore/host/memory/poke"

Field Value

string

HostProjectAnalyze

Asks the environment host to compose a project of the workspace other than the one it runs, for analysis only (HostProjectAnalyzeParams): what the language server asks for each other project it loads, before it defines that project's modules.

public const string HostProjectAnalyze = "rdcore/host/project/analyze"

Field Value

string

HostProjectRelease

Asks the environment host to drop a project it composed for analysis (HostProjectReleaseParams): what the language server asks once the client took the project's folder out of the workspace.

public const string HostProjectRelease = "rdcore/host/project/release"

Field Value

string

HostProjectReload

Asks the environment host to compose its runtime session again from the project file as it is now: what the language server asks once a client said the .rdproj changed (workspace/didChangeWatchedFiles), before it defines the workspace again.

public const string HostProjectReload = "rdcore/host/project/reload"

Field Value

string

HostRunSessionClose

Asks the environment host to close a run session.

public const string HostRunSessionClose = "rdcore/host/runSession/close"

Field Value

string

HostRunSessionExecute

Asks the environment host to run one procedure of a run session's project, unattended, with the arguments of a data row and the fakes of the run.

public const string HostRunSessionExecute = "rdcore/host/runSession/execute"

Field Value

string

HostRunSessionOpen

Asks the environment host to open a run session of a project, in which its procedures are run one request at a time: what a test runner opens for a test module.

public const string HostRunSessionOpen = "rdcore/host/runSession/open"

Field Value

string

HostSemantics

Asks the environment host for the semantic model of the code it holds: what the language server hands a diagnostics provider.

public const string HostSemantics = "rdcore/host/semantics"

Field Value

string

HostSessionStatus

Asks the environment host for the state of the runtime session it owns. The language-server side of SessionStatus.

public const string HostSessionStatus = "rdcore/host/session/status"

Field Value

string

ParseFullDocument

Requests an AST from the parser for a full document.

public const string ParseFullDocument = "rdcore/parser/document"

Field Value

string

ParseTokens

Requests the lexical tokens of a text from the parser.

public const string ParseTokens = "rdcore/parser/tokens"

Field Value

string