Packages

class NetworkClient extends AutoCloseable

A NetworkClient connects to a running sbt instance or starts a new instance if there isn't already one running. Once connected, it can send commands for sbt to run, it can send completions to sbt and print the completions to stdout so that a shell can consume the completions or it can enter an interactive sbt shell session in which it relays io bytes between sbt and the terminal.

Self Type
NetworkClient
Linear Supertypes
AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NetworkClient
  2. AutoCloseable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NetworkClient(configuration: AppConfiguration, args: List[String])
  2. new NetworkClient(configuration: AppConfiguration, arguments: Arguments)
  3. new NetworkClient(arguments: Arguments, console: ConsoleInterface, inputStream: InputStream, errorStream: PrintStream, printStream: PrintStream, useJNI: Boolean)

    arguments

    the arguments for the forked sbt server if the client needs to start it. It also contains the sbt command arguments to send to the server if any are present.

    console

    a logging instance. This can use a ConsoleAppender or just simply print to a PrintStream.

    inputStream

    the InputStream from which the client reads bytes. It is not hardcoded to System.in so that a NetworkClient can be remotely controlled by a java process, which is useful in testing.

    errorStream

    the sink for messages that we always want to be printed. It is usually System.err but could be overridden in tests or set to a null OutputStream if the NetworkClient needs to be silent.

    printStream

    the sink for standard out messages. It is typically System.out but in the case of completions, the bytes written to System.out are usually treated as completion results so we need to reroute standard out messages to System.err. It's also useful to override this in testing.

    useJNI

    toggles whether or not to use the jni based implementations in org.scalasbt.ipcsocket. These are only available on 64 bit linux, mac and windows. Any other platform will need to fall back on jna.

Value Members

  1. def batchExecute(userCommands: List[String]): Int
  2. def close(): Unit
    Definition Classes
    NetworkClient → AutoCloseable
  3. def connect(log: Boolean, promptCompleteUsers: Boolean): Boolean
  4. def connection: ServerConnection
  5. def getCompletions(query: String): Seq[String]
  6. def init(promptCompleteUsers: Boolean, retry: Boolean): ServerConnection
  7. def messageTypeToLevel(severity: Long): util.Level.Value
  8. def onNotification(msg: JsonRpcNotificationMessage): Unit
  9. def onRequest(msg: JsonRpcRequestMessage): Unit
  10. def onResponse(msg: JsonRpcResponseMessage): Unit
  11. def onReturningReponse(msg: JsonRpcResponseMessage): Unit

    Called on the response for a returning message.

  12. def run(): Int
  13. def sendCancelAllCommand(): LinkedBlockingQueue[Boolean]
  14. def sendCommand(command: CommandMessage): Unit
  15. def sendCommandResponse(method: String, command: EventMessage, id: String): Unit
  16. def sendExecCommand(commandLine: String): LinkedBlockingQueue[Integer]
  17. def sendJson(method: String, params: String, uuid: String): Unit
  18. def sendJson(method: String, params: String): String
  19. def sendNotification(method: String, params: String): Unit
  20. def splitDiagnostics(params: PublishDiagnosticsParams): Vector[(util.Level.Value, String)]
  21. def splitLogMessage(params: LogMessageParams): Vector[(util.Level.Value, String)]
  22. def waitForServer(portfile: File, log: Boolean, startServer: Boolean): Unit

    Forks another instance of sbt in the background.

    Forks another instance of sbt in the background. This instance must be shutdown explicitly via sbt -client shutdown