prox-core/io.github.vigoo.prox/ProcessGroupModule/ProcessGroup/ProcessGroupImplOE

ProcessGroupImplOE

case class ProcessGroupImplOE[O, E](firstProcess: UnboundIProcess[ProxStream[Byte], E], innerProcesses: List[UnboundIProcess[ProxStream[Byte], E]], lastProcess: UnboundIProcess[O, E], originalProcesses: List[Process[Unit, Unit]]) extends ProcessGroup[O, E] with RedirectableInput[ProcessGroupImplIOE[O, E]]

Process group with bound output and error streams

trait Serializable
trait Product
trait Equals
trait ProcessGroup[O, E]
class Object
trait Matchable
class Any

Type members

Inherited classlikes

class ConfigApplication[P <: ProcessLikeConfiguration]
object ConfigApplication

Types

override type Self = ProcessGroupImplOE[O, E]

Value members

Concrete methods

override def connectInput(source: InputRedirection): ProcessGroupImplIOE[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.

Value parameters:
source

Redirection source

Returns:

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

Definition Classes
def map(f: Mapper[O, E]): ProcessGroupImplOE[O, E]

Applies the given mapper to each process in the group

Applies the given mapper to each process in the group

Value parameters:
f

process mapper

Returns:

a new process group with all the processes altered by the mapper

Inherited methods

def !<(stream: ProxStream[Byte]): P

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.

Value parameters:
stream

Input stream

Returns:

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

Inherited from:
RedirectableInput
def <(stream: ProxStream[Byte]): P

Feed the process input from a byte stream.

Feed the process input from a byte stream.

An alias for fromStream.

Value parameters:
stream

Input stream

Returns:

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

Inherited from:
RedirectableInput
def <(path: Path): P

Feed the process input from a file natively.

Feed the process input from a file natively.

An alias for fromFile.

Value parameters:
path

Path to the file

Returns:

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

Inherited from:
RedirectableInput
def `with`(nameValuePair: (String, String)): Self

Adds an environment variable to the process

Adds an environment variable to the process

Value parameters:
nameValuePair

A pair of name and value

Returns:

a new process with the working directory set

Inherited from:
ProcessLikeConfiguration
override protected def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
def fromFile(path: Path): P

Feed the process input from a file natively.

Feed the process input from a file natively.

An alias for &lt;.

Value parameters:
path

Path to the file

Returns:

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

Inherited from:
RedirectableInput
def fromStream(stream: ProxStream[Byte], flushChunks: Boolean): P

Feed the process input from a byte stream.

Feed the process input from a byte stream.

An alias for &lt; and !&lt;.

Value parameters:
flushChunks

Flush the process input stream after each chunk

stream

Input stream

Returns:

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

Inherited from:
RedirectableInput
def in(workingDirectory: Path): Self

Changes the working directory of the process

Changes the working directory of the process

Value parameters:
workingDirectory

the working directory

Returns:

a new process with the working directory set

Inherited from:
ProcessLikeConfiguration
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

Inherited from:
ProcessLikeConfiguration
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def run[Info]()(implicit runner: ProcessRunner[Info]): ProxIO[ProcessGroupResult[O, E]]

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

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

Value parameters:
runner

The process runner to be used

Returns:

the result of the finished processes

Inherited from:
ProcessGroup
def start[Info]()(implicit runner: ProcessRunner[Info]): ProxResource[ProxFiber[ProcessGroupResult[O, E]]]

Starts the process group asynchronously and returns a closeable fiber representing it

Starts the process group asynchronously and returns a closeable fiber representing it

Joining the fiber waits for the processes to be terminated. Canceling the fiber terminates the processesnormally (with SIGTERM).

Value parameters:
runner

The process runner to be used

Returns:

a managed fiber representing the running processes

Inherited from:
ProcessGroup
def startProcessGroup[Info]()(implicit runner: ProcessRunner[Info]): ProxIO[RunningProcessGroup[O, E, Info]]

Starts the process group asynchronously and returns the RunningProcessGroup interface for it

Starts the process group asynchronously and returns the RunningProcessGroup interface for it

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

Type parameters:
Info

The runner-specific information about the started processes

Value parameters:
runner

The process runner to be used

Returns:

interface for handling the running process group

Inherited from:
ProcessGroup
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.

Value parameters:
name

Name of the environment variable

Returns:

a new process with the working directory set

Inherited from:
ProcessLikeConfiguration

Inherited fields

override val environmentVariables: Map[String, String]
override val removedEnvironmentVariables: Set[String]
override val workingDirectory: Option[Path]