lsprpc

Documentation

Overview

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

Index

• func ConnectToRemote(ctx context.Context, addr string) (net.Conn, error)
• func ExecuteCommand(ctx context.Context, addr string, id string, request, result any) error
• func NewForwarder(rawAddr string, argFunc func(network, address string) []string) (jsonrpc2.StreamServer, error)
• func ParseAddr(listen string) (network string, address string)
• func QueryServerState(ctx context.Context, addr string) (any, error)
• type StreamServer
  • func NewStreamServer(cache *cache.Cache, daemon bool, optionsFunc func(*settings.Options)) *StreamServer
  • func (s *StreamServer) FirstSession() (*cache.Session, protocol.Server)
  • func (s *StreamServer) ServeStream(ctx context.Context, conn jsonrpc2.Conn) error
  • func (s *StreamServer) Session(id string) (*cache.Session, protocol.Server)
  • func (s *StreamServer) SetSessionExitFunc(f func(id string))

Functions

func ConnectToRemote

func ConnectToRemote(ctx context.Context, addr string) (net.Conn, error)

func ExecuteCommand

func ExecuteCommand(ctx context.Context, addr string, id string, request, result any) error

ExecuteCommand connects to the named server, sends it a workspace/executeCommand request (with command 'id' and arguments JSON encoded in 'request'), and populates the result variable.

func NewForwarder

func NewForwarder(rawAddr string, argFunc func(network, address string) []string) (jsonrpc2.StreamServer, error)

NewForwarder creates a new forwarder (a jsonrpc2.StreamServer), ready to forward connections to the remote server specified by rawAddr. If provided and rawAddr indicates an 'automatic' address (starting with 'auto;'), argFunc may be used to start a remote server for the auto-discovered address.

func ParseAddr

func ParseAddr(listen string) (network string, address string)

ParseAddr parses the address of a gopls remote. TODO(rFindley): further document this syntax, and allow URI-style remote addresses such as "auto://...".

func QueryServerState

func QueryServerState(ctx context.Context, addr string) (any, error)

QueryServerState returns a JSON-encodable struct describing the state of the named server.

Types

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, daemon bool, optionsFunc func(*settings.Options)) *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) FirstSession

func (s *StreamServer) FirstSession() (*cache.Session, protocol.Server)

FirstSession returns the first session by lexically sorted session ID, or (nil, nil).

func (*StreamServer) ServeStream

func (s *StreamServer) ServeStream(ctx context.Context, conn jsonrpc2.Conn) error

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

func (*StreamServer) Session

func (s *StreamServer) Session(id string) (*cache.Session, protocol.Server)

Session returns the current active session for the given id, or (nil, nil) if none exists.

func (*StreamServer) SetSessionExitFunc

func (s *StreamServer) SetSessionExitFunc(f func(id string))

SetSessionExitFunc sets the function to call when sessions exit. It is not concurrency safe, and must only be called at most once, before the receiver is passed to jsonrpc2.Serve.