Package hudson

Class TcpSlaveAgentListener.PingAgentProtocol

java.lang.Object

jenkins.AgentProtocol

hudson.TcpSlaveAgentListener.PingAgentProtocol

All Implemented Interfaces:

ExtensionPoint

Enclosing class:

TcpSlaveAgentListener

@Extension
@Symbol("ping")
public static class TcpSlaveAgentListener.PingAgentProtocol
extends AgentProtocol

This extension provides a Ping protocol that allows people to verify that the TcpSlaveAgentListener is alive. We also use this to wake the acceptor thread on termination.

Since:

1.653

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
PingAgentProtocol()

Method Summary

Modifier and Type	Method	Description
boolean	connect(Socket socket)
String	getDisplayName()	Returns the human readable protocol display name.
String	getName()	Protocol name.
void	handle(Socket socket)	Called by the connection handling thread to execute the protocol.
boolean	isRequired()	Allow essential AgentProtocol implementations (basically TcpSlaveAgentListener.PingAgentProtocol) to be always enabled.

Methods inherited from class jenkins.AgentProtocol

all, isDeprecated, isOptIn, of

Methods inherited from class java.lang.Object

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

Constructor Detail

PingAgentProtocol

public PingAgentProtocol()

Method Detail

isRequired

public boolean isRequired()

Description copied from class: AgentProtocol

Allow essential AgentProtocol implementations (basically TcpSlaveAgentListener.PingAgentProtocol) to be always enabled.

Overrides:

isRequired in class AgentProtocol

Returns:

true if the protocol can never be disabled.

getName

public String getName()

Description copied from class: AgentProtocol

Protocol name. This is a short string that consists of printable ASCII chars. Sent by the client to select the protocol.

Specified by:

getName in class AgentProtocol

Returns:

null to be disabled. This is useful for avoiding getting used until the protocol is properly configured.

getDisplayName

public String getDisplayName()

Description copied from class: AgentProtocol

Returns the human readable protocol display name.

Overrides:

getDisplayName in class AgentProtocol

Returns:

the human readable protocol display name.

handle

public void handle(Socket socket)
            throws IOException,
                   InterruptedException

Description copied from class: AgentProtocol

Called by the connection handling thread to execute the protocol.

Specified by:

handle in class AgentProtocol

Throws:

IOException

InterruptedException

connect

public boolean connect(Socket socket)
                throws IOException

Throws:

IOException