interface PipesInterface in Zircon Profile 8

PipesInterface manages descriptors and pipes for the use of proc_open.

@author Romain Neutron <[e-mail]>

@internal

Hierarchy

• interface \Symfony\Component\Process\Pipes\PipesInterface

2 files declare their use of PipesInterface

AbstractProcessTest.php in vendor/symfony/process/Tests/AbstractProcessTest.php

Process.php in vendor/symfony/process/Process.php

File

vendor/symfony/process/Pipes/PipesInterface.php, line 21

Namespace

Symfony\Component\Process\Pipes

interface PipesInterface {
  const CHUNK_SIZE = 16384;

  /**
   * Returns an array of descriptors for the use of proc_open.
   *
   * @return array
   */
  public function getDescriptors();

  /**
   * Returns an array of filenames indexed by their related stream in case these pipes use temporary files.
   *
   * @return string[]
   */
  public function getFiles();

  /**
   * Reads data in file handles and pipes.
   *
   * @param bool $blocking Whether to use blocking calls or not.
   * @param bool $close    Whether to close pipes if they've reached EOF.
   *
   * @return string[] An array of read data indexed by their fd.
   */
  public function readAndWrite($blocking, $close = false);

  /**
   * Returns if the current state has open file handles or pipes.
   *
   * @return bool
   */
  public function areOpen();

  /**
   * Closes file handles and pipes.
   */
  public function close();

}

Members

Name	Modifiers	Type	Description	Overrides
PipesInterface::areOpen	public	function	Returns if the current state has open file handles or pipes.	2
PipesInterface::CHUNK_SIZE		constant
PipesInterface::close	public	function	Closes file handles and pipes.	1
PipesInterface::getDescriptors	public	function	Returns an array of descriptors for the use of proc_open.	2
PipesInterface::getFiles	public	function	Returns an array of filenames indexed by their related stream in case these pipes use temporary files.	2
PipesInterface::readAndWrite	public	function	Reads data in file handles and pipes.	2