com.sshtools.synergy.ssh

Interface Service

All Known Implementing Classes:

ConnectionProtocol

public interface Service

A service is a protocol that operates on top of the TransportProtocol.

Method Summary

Modifier and Type	Method and Description
int	getIdleTimeoutSeconds() How long does the service allow idle for?
java.lang.String	getName() The service name
boolean	idle() The service has reached idle timeout seconds
boolean	processMessage(byte[] msg) Process a transport message.
void	start() Start the service.
void	stop() Stop the service

Method Detail

processMessage

boolean processMessage(byte[] msg)
                throws java.io.IOException,
                       SshException

Process a transport message. When a message is received by the TransportProtocol that is not a transport level message the message is passed onto the active service using this method. The service processes the message and returns a value to indicate whether the message was used.

Parameters:

msg -

Returns:

true if the message was processed, otherwise false

Throws:

java.io.IOException

SshException

start

void start()
    throws SshException

Start the service.

Throws:

SshException

stop

void stop()

Stop the service

getIdleTimeoutSeconds

int getIdleTimeoutSeconds()

How long does the service allow idle for?

Returns:

getName

java.lang.String getName()

The service name

Returns:

idle

boolean idle()

The service has reached idle timeout seconds

Returns: