Package org.jacoco.core.runtime

Class RemoteControlWriter

java.lang.Object

org.jacoco.core.data.ExecutionDataWriter

org.jacoco.core.runtime.RemoteControlWriter

All Implemented Interfaces:

IExecutionDataVisitor, ISessionInfoVisitor, IRemoteCommandVisitor

public class RemoteControlWriter
extends ExecutionDataWriter
implements IRemoteCommandVisitor

ExecutionDataWriter with commands added for runtime remote control.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	BLOCK_CMDDUMP	Block identifier for dump command
static final byte	BLOCK_CMDOK	Block identifier to confirm successful command execution.

Fields inherited from class org.jacoco.core.data.ExecutionDataWriter

BLOCK_EXECUTIONDATA, BLOCK_HEADER, BLOCK_SESSIONINFO, FORMAT_VERSION, MAGIC_NUMBER, out

Constructor Summary

Constructors

Constructor	Description
RemoteControlWriter(OutputStream output)	Creates a new writer based on the given output stream.

Method Summary

Modifier and Type	Method	Description
void	sendCmdOk()	Sends a confirmation that a commands has been successfully executed and the response is completed.
void	visitDumpCommand(boolean dump, boolean reset)	Requests an execution data dump with an optional reset.

Methods inherited from class org.jacoco.core.data.ExecutionDataWriter

flush, getFileHeader, visitClassExecution, visitSessionInfo

Methods inherited from class java.lang.Object

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

Field Details

BLOCK_CMDOK

public static final byte BLOCK_CMDOK

Block identifier to confirm successful command execution.

See Also:

• Constant Field Values

BLOCK_CMDDUMP

public static final byte BLOCK_CMDDUMP

Block identifier for dump command

See Also:

• Constant Field Values

Constructor Details

RemoteControlWriter

public RemoteControlWriter(OutputStream output)
                    throws IOException

Creates a new writer based on the given output stream. Depending on the nature of the underlying stream output should be buffered as most data is written in single bytes. Should be buffered when used to write execution data to Socket.getOutputStream(). Should not be buffered when used only for commands because they are short and this will merely add memory overhead.

Parameters:

output - stream to write commands to

Throws:

IOException - if the header can't be written

Method Details

sendCmdOk

public void sendCmdOk()
               throws IOException

Sends a confirmation that a commands has been successfully executed and the response is completed.

Throws:

IOException - in case of problems with the remote connection

visitDumpCommand

public void visitDumpCommand(boolean dump,
 boolean reset)
                      throws IOException

Description copied from interface: IRemoteCommandVisitor

Requests an execution data dump with an optional reset.

Specified by:

visitDumpCommand in interface IRemoteCommandVisitor

Parameters:

dump - true if the dump should be executed

reset - true if the reset should be executed

Throws:

IOException - in case of problems with the remote connection