lsp4clj.socket-server — com.github.clojure-lsp/lsp4clj 1.9.3

DEPRECATED: Start a socket and listen on it.

This namespace is deprecated and is scheduled for deletion. See the README for recommendations on how to communicate with an LSP client over a socket.

This namespace was implemented based on a misconception. The LSP spec says servers should accept a --port CLI argument for socket-based communication. We assumed that the server was expected to start a socket server on that port, then wait for the client to connect and start sending messages. However, this is not how clients actually work. Instead, the client opens the socket server, and tells the LSP server which port to connect to. That is, the LSP client acts as a socket server and the LSP server acts as a socket client.

This namespace, which largely deals with starting a socket server, is therefore unusable in an LSP server. If the LSP server did try to open a server on the provided --port, it should always fail, because the client should already be listening on that port.

bind-socket clj

(bind-socket {:keys [address port]})

Binds to the :address (string, loopback by default) and :port (integer, required).

Returns a map containing the :socket (a ServerSocket) and a :connection, a future which will resolve (to a Socket) when a client connects.

The caller is responsible for closing the socket and the connection.

server clj

(server {:keys [address port] :as opts})

(server opts {:keys [socket connection]})

Start a socket server, given the specified opts: :address Host or address, string, defaults to loopback address :port Port, string or integer, required

Starts listening on the socket, blocks until a client establishes a connection, then returns a chan-server which communicates over the socket.