Package 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
    Description
    String
    getIdleLog()
    Information for logging purposes when an ignore message is sent during idle.
    int
    getIdleTimeoutSeconds()
    How long does the service allow idle for?
    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 Details

    • processMessage

      boolean processMessage(byte[] msg) throws 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:
      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

      String getName()
      The service name
      Returns:

    • idle

      boolean idle()
      The service has reached idle timeout seconds
      Returns:

    • getIdleLog

      String getIdleLog()
      Information for logging purposes when an ignore message is sent during idle.
      Returns: