org.eclipse.lsp4j.jsonrpc.debug

Class DebugLauncher

java.lang.Object

org.eclipse.lsp4j.jsonrpc.debug.DebugLauncher

public final class DebugLauncher
extends java.lang.Object

This is the entry point for applications that use the debug protocol. A DebugLauncher does all the wiring that is necessary to connect your endpoint via an input stream and an output stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DebugLauncher.Builder<T> Launcher builder for the debug protocol.

Method Summary

Modifier and Type	Method and Description
static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T>	createIoLauncher(java.lang.Object localService, java.lang.Class<T> remoteInterface, java.io.InputStream in, java.io.OutputStream out, java.util.concurrent.ExecutorService executorService, java.util.function.Function<org.eclipse.lsp4j.jsonrpc.MessageConsumer,org.eclipse.lsp4j.jsonrpc.MessageConsumer> wrapper) Create a new Launcher for a given local service object, a given remote interface and an input and output stream.
static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T>	createIoLauncher(java.lang.Object localService, java.lang.Class<T> remoteInterface, java.io.InputStream in, java.io.OutputStream out, java.util.concurrent.ExecutorService executorService, java.util.function.Function<org.eclipse.lsp4j.jsonrpc.MessageConsumer,org.eclipse.lsp4j.jsonrpc.MessageConsumer> wrapper, java.util.function.Consumer<com.google.gson.GsonBuilder> configureGson) Create a new Launcher for a given local service object, a given remote interface and an input and output stream.
static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T>	createLauncher(java.lang.Object localService, java.lang.Class<T> remoteInterface, java.io.InputStream in, java.io.OutputStream out) Create a new Launcher for a given local service object, a given remote interface and an input and output stream.
static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T>	createLauncher(java.lang.Object localService, java.lang.Class<T> remoteInterface, java.io.InputStream in, java.io.OutputStream out, boolean validate, java.io.PrintWriter trace) Create a new Launcher for a given local service object, a given remote interface and an input and output stream, and set up message validation and tracing.
static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T>	createLauncher(java.lang.Object localService, java.lang.Class<T> remoteInterface, java.io.InputStream in, java.io.OutputStream out, java.util.concurrent.ExecutorService executorService, java.util.function.Function<org.eclipse.lsp4j.jsonrpc.MessageConsumer,org.eclipse.lsp4j.jsonrpc.MessageConsumer> wrapper) Create a new Launcher for a given local service object, a given remote interface and an input and output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createLauncher

public static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T> createLauncher(java.lang.Object localService,
                                                                       java.lang.Class<T> remoteInterface,
                                                                       java.io.InputStream in,
                                                                       java.io.OutputStream out)

Create a new Launcher for a given local service object, a given remote interface and an input and output stream.

Parameters:

localService - - an object on which classes RPC methods are looked up

remoteInterface - - an interface on which RPC methods are looked up

in - - inputstream to listen for incoming messages

out - - outputstream to send outgoing messages

createLauncher

public static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T> createLauncher(java.lang.Object localService,
                                                                       java.lang.Class<T> remoteInterface,
                                                                       java.io.InputStream in,
                                                                       java.io.OutputStream out,
                                                                       boolean validate,
                                                                       java.io.PrintWriter trace)

Create a new Launcher for a given local service object, a given remote interface and an input and output stream, and set up message validation and tracing.

Parameters:

localService - - an object on which classes RPC methods are looked up

remoteInterface - - an interface on which RPC methods are looked up

in - - inputstream to listen for incoming messages

out - - outputstream to send outgoing messages

validate - - whether messages should be validated with the ReflectiveMessageValidator

trace - - a writer to which incoming and outgoing messages are traced, or null to disable tracing

createLauncher

public static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T> createLauncher(java.lang.Object localService,
                                                                       java.lang.Class<T> remoteInterface,
                                                                       java.io.InputStream in,
                                                                       java.io.OutputStream out,
                                                                       java.util.concurrent.ExecutorService executorService,
                                                                       java.util.function.Function<org.eclipse.lsp4j.jsonrpc.MessageConsumer,org.eclipse.lsp4j.jsonrpc.MessageConsumer> wrapper)

Create a new Launcher for a given local service object, a given remote interface and an input and output stream. Threads are started with the given executor service. The wrapper function is applied to the incoming and outgoing message streams so additional message handling such as validation and tracing can be included.

Parameters:

localService - - an object on which classes RPC methods are looked up

remoteInterface - - an interface on which RPC methods are looked up

in - - inputstream to listen for incoming messages

out - - outputstream to send outgoing messages

executorService - - the executor service used to start threads

wrapper - - a function for plugging in additional message consumers

createIoLauncher

public static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T> createIoLauncher(java.lang.Object localService,
                                                                         java.lang.Class<T> remoteInterface,
                                                                         java.io.InputStream in,
                                                                         java.io.OutputStream out,
                                                                         java.util.concurrent.ExecutorService executorService,
                                                                         java.util.function.Function<org.eclipse.lsp4j.jsonrpc.MessageConsumer,org.eclipse.lsp4j.jsonrpc.MessageConsumer> wrapper)

Create a new Launcher for a given local service object, a given remote interface and an input and output stream. Threads are started with the given executor service. The wrapper function is applied to the incoming and outgoing message streams so additional message handling such as validation and tracing can be included.

Parameters:

localService - - an object on which classes RPC methods are looked up

remoteInterface - - an interface on which RPC methods are looked up

in - - inputstream to listen for incoming messages

out - - outputstream to send outgoing messages

executorService - - the executor service used to start threads

wrapper - - a function for plugging in additional message consumers

createIoLauncher

public static <T> org.eclipse.lsp4j.jsonrpc.Launcher<T> createIoLauncher(java.lang.Object localService,
                                                                         java.lang.Class<T> remoteInterface,
                                                                         java.io.InputStream in,
                                                                         java.io.OutputStream out,
                                                                         java.util.concurrent.ExecutorService executorService,
                                                                         java.util.function.Function<org.eclipse.lsp4j.jsonrpc.MessageConsumer,org.eclipse.lsp4j.jsonrpc.MessageConsumer> wrapper,
                                                                         java.util.function.Consumer<com.google.gson.GsonBuilder> configureGson)

Create a new Launcher for a given local service object, a given remote interface and an input and output stream. Threads are started with the given executor service. The wrapper function is applied to the incoming and outgoing message streams so additional message handling such as validation and tracing can be included. The configureGson function can be used to register additional type adapters in the GsonBuilder in order to support protocol classes that cannot be handled by Gson's reflective capabilities.

Parameters:

localService - - an object on which classes RPC methods are looked up

remoteInterface - - an interface on which RPC methods are looked up

in - - inputstream to listen for incoming messages

out - - outputstream to send outgoing messages

executorService - - the executor service used to start threads

wrapper - - a function for plugging in additional message consumers

configureGson - - a function for Gson configuration