Class TcpServerOutput

java.lang.Object

org.jacoco.agent.rt.internal.output.TcpServerOutput

All Implemented Interfaces:

IAgentOutput

public class TcpServerOutput
extends Object
implements IAgentOutput

Output that opens TCP server socket. This controller uses the following agent options:

• address
• port

Field Summary

Fields

Modifier and Type	Field	Description
private TcpConnection	connection
private final IExceptionLogger	logger
private ServerSocket	serverSocket
private Thread	worker

Constructor Summary

Constructors

Constructor	Description
TcpServerOutput(IExceptionLogger logger)	New controller instance.

Method Summary

Modifier and Type	Method	Description
protected ServerSocket	createServerSocket(AgentOptions options)	Open a server socket based on the given configuration.
protected InetAddress	getInetAddress(String address)	Returns the InetAddress object to open the server socket on.
void	shutdown()	Shutdown the agent controller and clean up any resources it has created.
void	startup(AgentOptions options, RuntimeData data)	Configure the agent controller with the supplied options and connect it to the coverage runtime
void	writeExecutionData(boolean reset)	Write all execution data in the runtime to a location determined by the agent controller.

Methods inherited from class Object

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

Field Details

connection

private TcpConnection connection

logger

private final IExceptionLogger logger

serverSocket

private ServerSocket serverSocket

worker

private Thread worker

Constructor Details

TcpServerOutput

public TcpServerOutput(IExceptionLogger logger)

New controller instance.

Parameters:

logger - logger to use in case of exceptions is spawned threads

Method Details

startup

public void startup(AgentOptions options,
 RuntimeData data)
             throws IOException

Description copied from interface: IAgentOutput

Configure the agent controller with the supplied options and connect it to the coverage runtime

Specified by:

startup in interface IAgentOutput

Parameters:

options - Options used to configure the agent controller

data - Execution data for this agent

Throws:

IOException

shutdown

public void shutdown()
              throws Exception

Description copied from interface: IAgentOutput

Shutdown the agent controller and clean up any resources it has created.

Specified by:

shutdown in interface IAgentOutput

Throws:

Exception - in case shutdown fails

writeExecutionData

public void writeExecutionData(boolean reset)
                        throws IOException

Description copied from interface: IAgentOutput

Write all execution data in the runtime to a location determined by the agent controller. This method should only be called by the Agent

Specified by:

writeExecutionData in interface IAgentOutput

Parameters:

reset - if true execution data is cleared afterwards

Throws:

IOException - in case writing fails

createServerSocket

protected ServerSocket createServerSocket(AgentOptions options)
                                   throws IOException

Open a server socket based on the given configuration.

Parameters:

options - address and port configuration

Returns:

opened server socket

Throws:

IOException

getInetAddress

protected InetAddress getInetAddress(String address)
                              throws UnknownHostException

Returns the InetAddress object to open the server socket on.

Parameters:

address - address specified as a string

Returns:

address to open the server socket

Throws:

UnknownHostException