lsprpc

Documentation

Overview

Package lsprpc implements a jsonrpc2.StreamServer that may be used to serve the LSP on a jsonrpc2 channel.

Index

• Constants
• Variables
• func OverrideExitFuncsForTest() func()
• type ClientSession
• type Forwarder
  • func NewForwarder(network, addr string, opts ...ForwarderOption) *Forwarder
  • func (f *Forwarder) ServeStream(ctx context.Context, stream jsonrpc2.Stream) error
• type ForwarderOption
• type RemoteDebugAddress
• type RemoteListenTimeout
• type RemoteLogfile
• type ServerState
  • func QueryServerState(ctx context.Context, network, address string) (*ServerState, error)
• type StreamServer
  • func NewStreamServer(cache *cache.Cache) *StreamServer
  • func (s *StreamServer) ServeStream(ctx context.Context, stream jsonrpc2.Stream) error

Constants

const AutoNetwork = "auto"

AutoNetwork is the pseudo network type used to signal that gopls should use automatic discovery to resolve a remote address.

Variables

var ForwarderExitFunc = os.Exit

ForwarderExitFunc is used to exit the forwarder process. It is mutable for testing purposes.

Functions

func OverrideExitFuncsForTest

func OverrideExitFuncsForTest() func()

OverrideExitFuncsForTest can be used from test code to prevent the test process from exiting on server shutdown. The returned func reverts the exit funcs to their previous state.

Types

type ClientSession

type ClientSession struct {
	ClientID  string `json:"clientID"`
	SessionID string `json:"sessionID"`
	Logfile   string `json:"logfile"`
	DebugAddr string `json:"debugAddr"`
}

ClientSession identifies a current client LSP session on the server. Note that it looks similar to handshakeResposne, but in fact 'Logfile' and 'DebugAddr' now refer to the client.

type Forwarder

type Forwarder struct {
	// contains filtered or unexported fields
}

A Forwarder is a jsonrpc2.StreamServer that handles an LSP stream by forwarding it to a remote. This is used when the gopls process started by the editor is in the `-remote` mode, which means it finds and connects to a separate gopls daemon. In these cases, we still want the forwarder gopls to be instrumented with telemetry, and want to be able to in some cases hijack the jsonrpc2 connection with the daemon.

func NewForwarder

func NewForwarder(network, addr string, opts ...ForwarderOption) *Forwarder

NewForwarder creates a new Forwarder, ready to forward connections to the remote server specified by network and addr.

func (*Forwarder) ServeStream

func (f *Forwarder) ServeStream(ctx context.Context, stream jsonrpc2.Stream) error

ServeStream dials the forwarder remote and binds the remote to serve the LSP on the incoming stream.

type ForwarderOption

type ForwarderOption interface {
	// contains filtered or unexported methods
}

A ForwarderOption configures the behavior of the LSP forwarder.

type RemoteDebugAddress

type RemoteDebugAddress string

RemoteDebugAddress configures the address used by the auto-started Gopls daemon for serving debug information.

type RemoteListenTimeout

type RemoteListenTimeout time.Duration

RemoteListenTimeout configures the amount of time the auto-started gopls daemon will wait with no client connections before shutting down.

type RemoteLogfile

type RemoteLogfile string

RemoteLogfile configures the logfile location for the auto-started gopls daemon.

type ServerState

type ServerState struct {
	Logfile         string          `json:"logfile"`
	DebugAddr       string          `json:"debugAddr"`
	GoplsPath       string          `json:"goplsPath"`
	CurrentClientID string          `json:"currentClientID"`
	Clients         []ClientSession `json:"clients"`
}

ServerState holds information about the gopls daemon process, including its debug information and debug information of all of its current connected clients.

func QueryServerState

func QueryServerState(ctx context.Context, network, address string) (*ServerState, error)

QueryServerState queries the server state of the current server.

type StreamServer

type StreamServer struct {
	// contains filtered or unexported fields
}

The StreamServer type is a jsonrpc2.StreamServer that handles incoming streams as a new LSP session, using a shared cache.

func NewStreamServer

func NewStreamServer(cache *cache.Cache) *StreamServer

NewStreamServer creates a StreamServer using the shared cache. If withTelemetry is true, each session is instrumented with telemetry that records RPC statistics.

func (*StreamServer) ServeStream

func (s *StreamServer) ServeStream(ctx context.Context, stream jsonrpc2.Stream) error

ServeStream implements the jsonrpc2.StreamServer interface, by handling incoming streams using a new lsp server.