Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package github
    Definition Classes
    io
  • package vigoo
    Definition Classes
    github
  • package prox

    Provides classes to work with system processes in a type safe way.

    Provides classes to work with system processes in a type safe way.

    Refer to the user guide for more information.

    A process to be executed is represented by the Process trait. Once it has finished running the results are in ProcessResult. We call a group of processes attached together a process group, represented by ProcessGroup, its result is described by ProcessGroupResult.

    Redirection of input, output and error is enabled by the RedirectableInput, RedirectableOutput and RedirectableError trait for single processes, and the RedirectableErrors trait for process groups.

    Processes and process groups are executed by a ProcessRunner, the default implementation is called JVMProcessRunner.

    Definition Classes
    vigoo
  • trait ProcessModule extends AnyRef
    Definition Classes
    prox
  • object Process
    Definition Classes
    ProcessModule
  • ProcessImpl
  • ProcessImplE
  • ProcessImplI
  • ProcessImplIE
  • ProcessImplIO
  • ProcessImplIOE
  • ProcessImplO
  • ProcessImplOE

case class ProcessImplOE[O, E](command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) ⇒ Prox.ProxIO[O], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) ⇒ Prox.ProxIO[E], inputRedirection: Prox.InputRedirection) extends Prox.Process[O, E] with Prox.RedirectableInput[ProcessImplIOE[O, E]] with Product with Serializable

Process with bound output and error streams

Linear Supertypes
Serializable, Serializable, Product, Equals, Prox.RedirectableInput[ProcessImplIOE[O, E]], Prox.Process[O, E], Prox.ProcessConfiguration, Prox.ProcessLikeConfiguration, ProcessLike, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessImplOE
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RedirectableInput
  7. Process
  8. ProcessConfiguration
  9. ProcessLikeConfiguration
  10. ProcessLike
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProcessImplOE(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String], outputRedirection: Prox.OutputRedirection, runOutputStream: (InputStream) ⇒ Prox.ProxIO[O], errorRedirection: Prox.OutputRedirection, runErrorStream: (InputStream) ⇒ Prox.ProxIO[E], inputRedirection: Prox.InputRedirection)

Type Members

  1. type Self = ProcessImplOE[O, E]
    Definition Classes
    ProcessImplOE → Process → ProcessLikeConfiguration

Value Members

  1. def !<(stream: Prox.ProxStream[Byte]): ProcessImplIOE[O, E]

    Feed the process input from a byte stream with flushing per chunks enabled.

    Feed the process input from a byte stream with flushing per chunks enabled.

    An alias for fromStream.

    stream

    Input stream

    returns

    A new process or process group with the input redirected and the input redirection capability removed.

    Definition Classes
    RedirectableInput
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##(): Int
    Definition Classes
    AnyRef → Any
  4. def <(stream: Prox.ProxStream[Byte]): ProcessImplIOE[O, E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for fromStream.

    stream

    Input stream

    returns

    A new process or process group with the input redirected and the input redirection capability removed.

    Definition Classes
    RedirectableInput
  5. def <(path: Path): ProcessImplIOE[O, E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for fromFile.

    path

    Path to the file

    returns

    A new process or process group with the input redirected and the input redirection capability removed.

    Definition Classes
    RedirectableInput
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
    Attributes
    protected
    Definition Classes
    ProcessConfiguration → ProcessLikeConfiguration
  8. val arguments: List[String]
    Definition Classes
    ProcessImplOE → Process
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. val command: String
    Definition Classes
    ProcessImplOE → Process
  12. def connectInput(source: Prox.InputRedirection): ProcessImplIOE[O, E]

    The low level method to attach an input to a process or process group.

    The low level method to attach an input to a process or process group.

    Use the other methods in this trait for convenience.

    source

    Redirection source

    returns

    A new process or process group with the input redirected and the input redirection capability removed.

    Definition Classes
    ProcessImplOE → RedirectableInput
  13. val environmentVariables: Map[String, String]
    Definition Classes
    ProcessImplOE → Process → ProcessLikeConfiguration
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. val errorRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplOE → Process
  16. def fromFile(path: Path): ProcessImplIOE[O, E]

    Feed the process input from a file natively.

    Feed the process input from a file natively.

    An alias for <.

    path

    Path to the file

    returns

    A new process or process group with the input redirected and the input redirection capability removed.

    Definition Classes
    RedirectableInput
  17. def fromStream(stream: Prox.ProxStream[Byte], flushChunks: Boolean): ProcessImplIOE[O, E]

    Feed the process input from a byte stream.

    Feed the process input from a byte stream.

    An alias for < and !<.

    stream

    Input stream

    flushChunks

    Flush the process input stream after each chunk

    returns

    A new process or process group with the input redirected and the input redirection capability removed.

    Definition Classes
    RedirectableInput
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def in(workingDirectory: Path): Self

    Changes the working directory of the process

    Changes the working directory of the process

    workingDirectory

    the working directory

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration
  20. def inInheritedWorkingDirectory(): Self

    Use the inherited working directory of the process instead of an explicit one

    Use the inherited working directory of the process instead of an explicit one

    returns

    a new process with the working directory cleared

    Definition Classes
    ProcessLikeConfiguration
  21. val inputRedirection: Prox.InputRedirection
    Definition Classes
    ProcessImplOE → Process
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. val outputRedirection: Prox.OutputRedirection
    Definition Classes
    ProcessImplOE → Process
  27. val removedEnvironmentVariables: Set[String]
    Definition Classes
    ProcessImplOE → Process → ProcessLikeConfiguration
  28. def run[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.ProcessResult[O, E]]

    Starts the process asynchronously and blocks the execution until it is finished

    Starts the process asynchronously and blocks the execution until it is finished

    runner

    The process runner to be used

    returns

    the result of the finished process

    Definition Classes
    Process
  29. val runErrorStream: (InputStream) ⇒ Prox.ProxIO[E]
    Definition Classes
    ProcessImplOE → Process
  30. val runOutputStream: (InputStream) ⇒ Prox.ProxIO[O]
    Definition Classes
    ProcessImplOE → Process
  31. def selfCopy(command: String, arguments: List[String], workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): ProcessImplOE[O, E]
    Attributes
    protected
    Definition Classes
    ProcessImplOE → ProcessConfiguration
  32. def start[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxResource[Prox.ProxFiber[Prox.ProcessResult[O, E]]]

    Starts the process asynchronously and returns a closeable fiber representing it

    Starts the process asynchronously and returns a closeable fiber representing it

    Joining the fiber waits for the process to be terminated. Canceling the fiber terminates the process normally (with SIGTERM).

    runner

    The process runner to be used

    returns

    a managed fiber representing the running process

    Definition Classes
    Process
  33. def startProcess[Info]()(implicit runner: Prox.ProcessRunner[Info]): Prox.ProxIO[Prox.RunningProcess[O, E, Info]]

    Starts the process asynchronously and returns the RunningProcess interface for it

    Starts the process asynchronously and returns the RunningProcess interface for it

    This is the most advanced way to start processes. See start and run as alternatives.

    Info

    The runner-specific process info type

    runner

    The process runner to be used

    returns

    interface for handling the running process

    Definition Classes
    Process
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def with(nameValuePair: (String, String)): Self

    Adds an environment variable to the process

    Adds an environment variable to the process

    nameValuePair

    A pair of name and value

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration
  39. def withArguments(newArguments: List[String]): Self

    Replaces the arguments

    Replaces the arguments

    newArguments

    new list of arguments

    returns

    returns a new process specification

    Definition Classes
    ProcessConfiguration
  40. def withCommand(newCommand: String): Self

    Replaces the command

    Replaces the command

    newCommand

    new value for the command to be executed

    returns

    returns a new process specification

    Definition Classes
    ProcessConfiguration
  41. def without(name: String): Self

    Removes an environment variable from the process

    Removes an environment variable from the process

    Usable to remove variables inherited from the parent process.

    name

    Name of the environment variable

    returns

    a new process with the working directory set

    Definition Classes
    ProcessLikeConfiguration
  42. val workingDirectory: Option[Path]
    Definition Classes
    ProcessImplOE → Process → ProcessLikeConfiguration

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Prox.RedirectableInput[ProcessImplIOE[O, E]]

Inherited from Prox.Process[O, E]

Inherited from Prox.ProcessConfiguration

Inherited from Prox.ProcessLikeConfiguration

Inherited from ProcessLike

Inherited from AnyRef

Inherited from Any

Ungrouped