Categorygo.rpcplugin.org/rpcplugin
modulepackage
0.3.0
Repository: https://github.com/rpcplugin/go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package plugintrace provides mechanisms to trace events in rpcplugin clients and servers, so that calling applications can record those events in their own application-specific logs or other trace mechanisms.

# Functions

New launches a plugin server in a child process and returns an object representing that ret.
Serve starts up a plugin server and blocks while serving requests.

# Variables

ForceServerWithoutTLS is a predefined function for use with ServerConfig.TLSConfig which makes a server not use TLS at all.
NotChildProcessError is the error value returned from Serve if it does not detect the "cookie" environment variable that is a heuristic for detecting whether or not the server is being launched from the expected parent process.

# Structs

ClientConfig is used to configure the behavior of a plugin client.
HandshakeConfig contains settings that the client and server must both agree on in order for a plugin connection to be established.
Plugin represents a currently-active plugin instance, with an associated child process that is running an RPC server.
ServerConfig is used to configure the behavior of a plugin server started by the Serve function.

# Interfaces

ClientVersion is the interface to implement to launch a client for a particular protocol version.
ServerVersion is the interface to implement to write a server for a particular plugin version.

# Type aliases

ClientVersionFunc is a function type that implements interface ClientVersion.
ServerVersionFunc is a function type that implements interface ServerVersion.