Package org.eclipse.lsp4j.jsonrpc

Class TracingMessageConsumer

java.lang.Object

org.eclipse.lsp4j.jsonrpc.TracingMessageConsumer

All Implemented Interfaces:

MessageConsumer

public class TracingMessageConsumer
extends java.lang.Object
implements MessageConsumer

A MessageConsumer that outputs logs in a format that can be parsed by the LSP Inspector. https://microsoft.github.io/language-server-protocol/inspector/

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TracingMessageConsumer.RequestMetadata	Data class for holding pending request metadata.

Constructor Summary

Constructors

Constructor	Description
TracingMessageConsumer(MessageConsumer messageConsumer, java.util.Map<java.lang.String,TracingMessageConsumer.RequestMetadata> sentRequests, java.util.Map<java.lang.String,TracingMessageConsumer.RequestMetadata> receivedRequests, java.io.PrintWriter printWriter, java.time.Clock clock)
TracingMessageConsumer(MessageConsumer messageConsumer, java.util.Map<java.lang.String,TracingMessageConsumer.RequestMetadata> sentRequests, java.util.Map<java.lang.String,TracingMessageConsumer.RequestMetadata> receivedRequests, java.io.PrintWriter printWriter, java.time.Clock clock, java.util.Locale locale)

Method Summary

Modifier and Type	Method	Description
void	consume(Message message)	Constructs a log string for a given Message.
void	setJsonHandler(MessageJsonHandler jsonHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

TracingMessageConsumer

public TracingMessageConsumer(MessageConsumer messageConsumer,
                              java.util.Map<java.lang.String,TracingMessageConsumer.RequestMetadata> sentRequests,
                              java.util.Map<java.lang.String,TracingMessageConsumer.RequestMetadata> receivedRequests,
                              java.io.PrintWriter printWriter,
                              java.time.Clock clock)

Parameters:

messageConsumer - The MessageConsumer to wrap.

sentRequests - A map that keeps track of pending sent request data.

receivedRequests - A map that keeps track of pending received request data.

printWriter - Where to write the log to.

clock - The clock that is used to calculate timestamps and durations.

TracingMessageConsumer

public TracingMessageConsumer(MessageConsumer messageConsumer,
                              java.util.Map<java.lang.String,TracingMessageConsumer.RequestMetadata> sentRequests,
                              java.util.Map<java.lang.String,TracingMessageConsumer.RequestMetadata> receivedRequests,
                              java.io.PrintWriter printWriter,
                              java.time.Clock clock,
                              java.util.Locale locale)

Parameters:

messageConsumer - The MessageConsumer to wrap.

sentRequests - A map that keeps track of pending sent request data.

receivedRequests - A map that keeps track of pending received request data.

printWriter - Where to write the log to.

clock - The clock that is used to calculate timestamps and durations.

locale - THe Locale to format the timestamps and durations, or null to use default locale.

Method Detail

setJsonHandler

public void setJsonHandler(MessageJsonHandler jsonHandler)

consume

public void consume(Message message)
             throws MessageIssueException,
                    JsonRpcException

Constructs a log string for a given Message. The type of the MessageConsumer determines if we're sending or receiving a message. The type of the @{link Message} determines if it is a request, response, or notification.

Specified by:

consume in interface MessageConsumer

Throws:

MessageIssueException - when an issue is found that prevents further processing of the message

JsonRpcException - when accessing the JSON-RPC communication channel fails