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

ProcessGroupImpl

case
class ProcessGroupImpl(firstProcess: UnboundIEProcess[ProxStream[Byte]], innerProcesses: List[UnboundIEProcess[ProxStream[Byte]]], lastProcess: UnboundProcess, originalProcesses: List[Process[Unit, Unit]]) extends ProcessGroup[Unit, Unit] with RedirectableOutput[ProcessGroupImplO] with RedirectableInput[ProcessGroupImplI] with RedirectableErrors[ProcessGroupImplE]

Process group with unbound input, output and error streams

trait Serializable
trait Product
trait Equals
trait ProcessGroup[Unit, Unit]
trait ProcessGroupConfiguration[Unit, Unit]
class Object
trait Matchable
class Any

Type members

Inherited classlikes

class ConfigApplication[P <: ProcessLikeConfiguration]
object ConfigApplication

Types

override
type Self = ProcessGroupImpl

Value members

Concrete methods

override
def connectErrors[R <: GroupErrorRedirection, OR <: OutputRedirection, E](target: R)(implicit groupErrorRedirectionType: Aux[R, OR, E], outputRedirectionType: Aux[OR, E]): ProcessGroupImplE[E]
Definition Classes
override
def connectInput(source: InputRedirection): ProcessGroupImplI
Definition Classes
override
def connectOutput[R <: OutputRedirection, RO](target: R)(implicit outputRedirectionType: Aux[R, RO]): ProcessGroupImplO[RO]
Definition Classes
def map(f: Mapper[Unit, Unit]): ProcessGroupImpl
def pipeInto(other: UnboundProcess, channel: ProxPipe[Byte, Byte]): ProcessGroupImpl
def via(channel: ProxPipe[Byte, Byte]): PipeBuilderSyntax[ProcessGroupImpl]

Inherited methods

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

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 Params
stream

Input stream

Returns

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

Inherited from
RedirectableInput
def !>(sink: ProxSink[Byte]): ProcessGroupImplE[Unit]

Redirects the error outputs to a sink.

Redirects the error outputs to a sink.

The process error output type will be Unit. An alias for errorsToSink

Value Params
sink

Target sink

Returns

Returns a new process group with all the error streams redirected and the error redirection capability removed.

Inherited from
RedirectableErrors
def !>#[O : ProxMonoid](pipe: ProxPipe[Byte, O]): ProcessGroupImplE[O]

Redirects the error outputs to a pipe and folds its output with a monoid instance.

Redirects the error outputs to a pipe and folds its output with a monoid instance.

The process error output type will be the same as the pipe's output type. An alias for errorsToFoldMonoid

Type Params
O

Output type of the pipe. Must have a monoid instance.

Value Params
pipe

Target pipe

Returns

Returns a new process group with all the error streams redirected and the error redirection capability removed.

Inherited from
RedirectableErrors
def !>?[O](pipe: ProxPipe[Byte, O]): ProcessGroupImplE[Vector[O]]

Redirects the error outputs to a pipe and collects its output to a vector

Redirects the error outputs to a pipe and collects its output to a vector

The process error output type will be a vector of the pipe's output type. An alias for errorsToVector

Type Params
O

Output type of the pipe

Value Params
pipe

Target pipe

Returns

Returns a new process group with all the error streams redirected and the error redirection capability removed.

Inherited from
RedirectableErrors
def <(stream: ProxStream[Byte]): ProcessGroupImplI

Feed the process input from a byte stream.

Feed the process input from a byte stream.

An alias for fromStream.

Value Params
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): ProcessGroupImplI

Feed the process input from a file natively.

Feed the process input from a file natively.

An alias for fromFile.

Value Params
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 >(path: Path): ProcessGroupImplO[Unit]

Redirects the output to a file natively

Redirects the output to a file natively

An alias for toFile

Value Params
path

Target file path

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def >(sink: ProxSink[Byte]): ProcessGroupImplO[Unit]

Redirects the output to a sink.

Redirects the output to a sink.

The process output type will be Unit. An alias for toSink

Value Params
sink

Target sink

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def >#[O : ProxMonoid](pipe: ProxPipe[Byte, O]): ProcessGroupImplO[O]

Redirects the output to a pipe and folds its output with a monoid instance.

Redirects the output to a pipe and folds its output with a monoid instance.

The process output type will be the same as the pipe's output type. An alias for toFoldMonoid

Type Params
O

Output type of the pipe. Must have a monoid instance.

Value Params
pipe

Target pipe

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def >>(path: Path): ProcessGroupImplO[Unit]

Redirects the output to a file natively in append mode

Redirects the output to a file natively in append mode

An alias for appendToFile

Value Params
path

Target file path

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def >?[O](pipe: ProxPipe[Byte, O]): ProcessGroupImplO[Vector[O]]

Redirects the output to a pipe and collects its output to a vector

Redirects the output to a pipe and collects its output to a vector

The process output type will be a vector of the pipe's output type. An alias for toVector

Type Params
O

Output type of the pipe

Value Params
pipe

Target pipe

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

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

Adds an environment variable to the process

Adds an environment variable to the process

Value Params
nameValuePair

A pair of name and value

Returns

a new process with the working directory set

Inherited from
ProcessLikeConfiguration
def appendToFile(path: Path): ProcessGroupImplO[Unit]

Redirects the output to a file natively in append mode

Redirects the output to a file natively in append mode

An alias for &gt;&gt;

Value Params
path

Target file path

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
override protected
def applyConfiguration(workingDirectory: Option[Path], environmentVariables: Map[String, String], removedEnvironmentVariables: Set[String]): Self
def drainErrors[O](pipe: ProxPipe[Byte, O]): ProcessGroupImplE[Unit]

Redirects the error outputs to a pipe and drains it regardless of its output type.

Redirects the error outputs to a pipe and drains it regardless of its output type.

The process error output type will be Unit.

Type Params
O

Output type of the pipe

Value Params
pipe

Target pipe

Returns

Returns a new process group with all the error streams redirected and the error redirection capability removed.

Inherited from
RedirectableErrors
def drainOutput[O](pipe: ProxPipe[Byte, O]): ProcessGroupImplO[Unit]

Redirects the output to a pipe and drains it regardless of its output type.

Redirects the output to a pipe and drains it regardless of its output type.

The process output type will be Unit.

Type Params
O

Output type of the pipe

Value Params
pipe

Target pipe

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def errorsToFoldMonoid[O : ProxMonoid](pipe: ProxPipe[Byte, O]): ProcessGroupImplE[O]

Redirects the error outputs to a pipe and folds its output with a monoid instance.

Redirects the error outputs to a pipe and folds its output with a monoid instance.

The process error output type will be the same as the pipe's output type. An alias for !&gt;#

Type Params
O

Output type of the pipe. Must have a monoid instance.

Value Params
pipe

Target pipe

Returns

Returns a new process group with all the error streams redirected and the error redirection capability removed.

Inherited from
RedirectableErrors
def errorsToSink(sink: ProxSink[Byte]): ProcessGroupImplE[Unit]

Redirects the error outputs to a sink.

Redirects the error outputs to a sink.

The process error output type will be Unit. An alias for !&gt;

Value Params
sink

Target sink

Returns

Returns a new process group with all the error streams redirected and the error redirection capability removed.

Inherited from
RedirectableErrors
def errorsToVector[O](pipe: ProxPipe[Byte, O]): ProcessGroupImplE[Vector[O]]

Redirects the error outputs to a pipe and collects its output to a vector

Redirects the error outputs to a pipe and collects its output to a vector

The process error output type will be a vector of the pipe's output type. An alias for !&gt;?

Type Params
O

Output type of the pipe

Value Params
pipe

Target pipe

Returns

Returns a new process group with all the error streams redirected and the error redirection capability removed.

Inherited from
RedirectableErrors
def foldErrors[O, R](pipe: ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplE[R]

Redirects the error outputs to a pipe and folds it with a custom function.

Redirects the error outputs to a pipe and folds it with a custom function.

The process error output type will be R.

Type Params
O

Output type of the pipe

R

Result type of the fold

Value Params
fn

The fold function

init

The initial value for the fold

pipe

Target pipe

Returns

Returns a new process group with all the error streams redirected and the error redirection capability removed.

Inherited from
RedirectableErrors
def foldOutput[O, R](pipe: ProxPipe[Byte, O], init: R, fn: (R, O) => R): ProcessGroupImplO[R]

Redirects the output to a pipe and folds it with a custom function.

Redirects the output to a pipe and folds it with a custom function.

The process output type will be R.

Type Params
O

Output type of the pipe

R

Result type of the fold

Value Params
fn

The fold function

init

The initial value for the fold

pipe

Target pipe

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def fromFile(path: Path): ProcessGroupImplI

Feed the process input from a file natively.

Feed the process input from a file natively.

An alias for &lt;.

Value Params
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): ProcessGroupImplI

Feed the process input from a byte stream.

Feed the process input from a byte stream.

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

Value Params
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 Params
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[Unit, Unit]]

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 Params
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[Unit, Unit]]]

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 Params
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[Unit, Unit, 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 Params
Info

The runner-specific information about the started processes

Value Params
runner

The process runner to be used

Returns

interface for handling the running process group

Inherited from
ProcessGroup
def toFile(path: Path): ProcessGroupImplO[Unit]

Redirects the output to a file natively

Redirects the output to a file natively

An alias for &gt;

Value Params
path

Target file path

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def toFoldMonoid[O : ProxMonoid](pipe: ProxPipe[Byte, O]): ProcessGroupImplO[O]

Redirects the output to a pipe and folds its output with a monoid instance.

Redirects the output to a pipe and folds its output with a monoid instance.

The process output type will be the same as the pipe's output type. An alias for &gt;#

Type Params
O

Output type of the pipe. Must have a monoid instance.

Value Params
pipe

Target pipe

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def toSink(sink: ProxSink[Byte]): ProcessGroupImplO[Unit]

Redirects the output to a sink.

Redirects the output to a sink.

The process output type will be Unit. An alias for &gt;

Value Params
sink

Target sink

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
def toVector[O](pipe: ProxPipe[Byte, O]): ProcessGroupImplO[Vector[O]]

Redirects the output to a pipe and collects its output to a vector

Redirects the output to a pipe and collects its output to a vector

The process output type will be a vector of the pipe's output type. An alias for &gt;?

Type Params
O

Output type of the pipe

Value Params
pipe

Target pipe

Returns

Returns a new process or process group with its output redirected and its output redirection capability removed.

Inherited from
RedirectableOutput
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 Params
name

Name of the environment variable

Returns

a new process with the working directory set

Inherited from
ProcessLikeConfiguration

Inherited fields

lazy
val customizedPerProcess: CustomizedPerProcess[ProcessGroupImplE]

A more advanced interface for customizing the redirection per process

A more advanced interface for customizing the redirection per process

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