Diviner Arcanist Tech Docs PhutilExecutableFuture

abstract class PhutilExecutableFuture
Arcanist Technical Documentation ()

This class is not documented.

Tasks

Configuring the Command

final public function setEnv($env, $wipe_process_env) — Set environmental variables for the command.
final public function updateEnv($key, $value) — Set the value of a specific environmental variable for this command.
final public function hasEnv() — Returns `true` if this command has a configured environment.
final public function getEnv() — Get the configured environment.
final public function setCWD($cwd) — Set the current working directory for the subprocess (that is, set where the subprocess will execute). If not set, the default value is the parent's current working directory.
final public function getCWD() — Get the command's current working directory.

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
abstract public function isReady() — Is this future's process complete? Specifically, can this future be resolved without blocking?
public function resolve() — Resolve a future and return its result, blocking until the result is ready if necessary.
final public function updateFuture()
private function startServiceProfiler()
private function endServiceProfiler()
protected function getServiceProfilerStartParameters()
protected function getServiceProfilerResultParameters()
public function getReadSockets() — Retrieve a list of sockets which we can wait to become readable while a future is resolving. If your future has sockets which can be `select()`ed, return them here (or in @{method:getWriteSockets}) to make the resolve loop do a `select()`. If you do not return sockets in either case, you'll get a busy wait.
public function getWriteSockets() — Retrieve a list of sockets which we can wait to become writable while a future is resolving. See @{method:getReadSockets}.
public function getDefaultWait() — Default amount of time to wait on stream select for this future. Normally 1 second is fine, but if the future has a timeout sooner than that it should return the amount of time left before the timeout.
public function start()
final protected function getResult() — Retrieve the final result of the future.
final protected function setResult($result)
final public function hasResult()
private function setException($exception)
private function getException()
final public function hasException()
final public function setFutureKey($key)
final public function getFutureKey()
final public function setRaiseExceptionOnStart($raise)
final public function getHasFutureStarted()
final public function canResolve()
private function endFuture()
final public function __construct($pattern)
protected function didConstruct()
final public function setResolveOnError($resolve_on_error)
final public function getResolveOnError()
final public function getCommand()

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

abstract public function isReady()
Inherited

Future

Is this future's process complete? Specifically, can this future be resolved without blocking?

Return

bool	If true, the external process is complete and resolving this future will not block.

public function resolve()
Inherited

Future

Resolve a future and return its result, blocking until the result is ready if necessary.

Return

wild	Future result.

final public function updateFuture()
Inherited

This method is not documented.

Return

wild

private function startServiceProfiler()
Inherited

This method is not documented.

Return

wild

private function endServiceProfiler()
Inherited

This method is not documented.

Return

wild

protected function getServiceProfilerStartParameters()
Inherited

This method is not documented.

Return

wild

protected function getServiceProfilerResultParameters()
Inherited

This method is not documented.

Return

wild

public function getReadSockets()
Inherited

Future

Retrieve a list of sockets which we can wait to become readable while a future is resolving. If your future has sockets which can be select()ed, return them here (or in getWriteSockets()) to make the resolve loop do a select(). If you do not return sockets in either case, you'll get a busy wait.

Return

list	A list of sockets which we expect to become readable.

public function getWriteSockets()
Inherited

Future

Retrieve a list of sockets which we can wait to become writable while a future is resolving. See getReadSockets().

Return

list	A list of sockets which we expect to become writable.

public function getDefaultWait()
Inherited

Future

Default amount of time to wait on stream select for this future. Normally 1 second is fine, but if the future has a timeout sooner than that it should return the amount of time left before the timeout.

Return

wild

public function start()
Inherited

This method is not documented.

Return

wild

final protected function getResult()
Inherited

Future

Retrieve the final result of the future.

Return

wild	Final resolution of this future.

final protected function setResult($result)
Inherited

This method is not documented.

Parameters

$result

Return

wild

final public function hasResult()
Inherited

This method is not documented.

Return

wild

private function setException($exception)
Inherited

This method is not documented.

Parameters

$exception

Return

wild

private function getException()
Inherited

This method is not documented.

Return

wild

final public function hasException()
Inherited

This method is not documented.

Return

wild

final public function setFutureKey($key)
Inherited

This method is not documented.

Parameters

$key

Return

wild

final public function getFutureKey()
Inherited

This method is not documented.

Return

wild

final public function setRaiseExceptionOnStart($raise)
Inherited

This method is not documented.

Parameters

$raise

Return

wild

final public function getHasFutureStarted()
Inherited

This method is not documented.

Return

wild

final public function canResolve()
Inherited

This method is not documented.

Return

wild

private function endFuture()
Inherited

This method is not documented.

Return

wild

final public function __construct($pattern)

This method is not documented.

Parameters

$pattern

Return

this	//Implicit.//

protected function didConstruct()

This method is not documented.

Return

wild

final public function setResolveOnError($resolve_on_error)

This method is not documented.

Parameters

$resolve_on_error

Return

wild

final public function getResolveOnError()

This method is not documented.

Return

wild

final public function getCommand()

This method is not documented.

Return

wild

final public function setEnv($env, $wipe_process_env)

Set environmental variables for the command.

By default, variables are added to the environment of this process. You can optionally wipe the environment and pass only the specified values.

// Env will have "X" and current env ("PATH", etc.)
$exec->setEnv(array('X' => 'y'));

// Env will have ONLY "X".
$exec->setEnv(array('X' => 'y'), $wipe_process_env = true);

Parameters

map<string,	$env	string> Dictionary of environmental variables.
bool	$wipe_process_env	Optionally, pass `true` to replace the existing environment.

Return

this

final public function updateEnv($key, $value)

Set the value of a specific environmental variable for this command.

Parameters

string	$key	Environmental variable name.
string\|null	$value	New value, or null to remove this variable.

Return

this

final public function hasEnv()

Returns true if this command has a configured environment.

Return

bool	True if this command has an environment.

final public function getEnv()

Get the configured environment.

Return

map<string, string>

Effective environment for this command.

final public function setCWD($cwd)

Set the current working directory for the subprocess (that is, set where the subprocess will execute). If not set, the default value is the parent's current working directory.

Parameters

string

$cwd

Directory to execute the subprocess in.

Return

this

final public function getCWD()

Get the command's current working directory.

Return

string

Working directory.

Defined: src/future/exec/PhutilExecutableFuture.php:6
Extends: PhobjectFuture

abstract class PhutilExecutableFutureArcanist Technical Documentation ()

Tasks

Configuring the Command

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

abstract public function isReady()Inherited

public function resolve()Inherited

final public function updateFuture()Inherited

private function startServiceProfiler()Inherited

private function endServiceProfiler()Inherited

protected function getServiceProfilerStartParameters()Inherited

protected function getServiceProfilerResultParameters()Inherited

public function getReadSockets()Inherited

public function getWriteSockets()Inherited

public function getDefaultWait()Inherited

public function start()Inherited

final protected function getResult()Inherited

final protected function setResult($result)Inherited

final public function hasResult()Inherited

private function setException($exception)Inherited

private function getException()Inherited

final public function hasException()Inherited

final public function setFutureKey($key)Inherited

final public function getFutureKey()Inherited

final public function setRaiseExceptionOnStart($raise)Inherited

final public function getHasFutureStarted()Inherited

final public function canResolve()Inherited

private function endFuture()Inherited

final public function __construct($pattern)

protected function didConstruct()

final public function setResolveOnError($resolve_on_error)

final public function getResolveOnError()

final public function getCommand()

final public function setEnv($env, $wipe_process_env)

final public function updateEnv($key, $value)

final public function hasEnv()

final public function getEnv()

final public function setCWD($cwd)

final public function getCWD()

abstract class PhutilExecutableFuture
Arcanist Technical Documentation ()

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

abstract public function isReady()
Inherited

public function resolve()
Inherited

final public function updateFuture()
Inherited

private function startServiceProfiler()
Inherited

private function endServiceProfiler()
Inherited

protected function getServiceProfilerStartParameters()
Inherited

protected function getServiceProfilerResultParameters()
Inherited

public function getReadSockets()
Inherited

public function getWriteSockets()
Inherited

public function getDefaultWait()
Inherited

public function start()
Inherited

final protected function getResult()
Inherited

final protected function setResult($result)
Inherited

final public function hasResult()
Inherited

private function setException($exception)
Inherited

private function getException()
Inherited

final public function hasException()
Inherited

final public function setFutureKey($key)
Inherited

final public function getFutureKey()
Inherited

final public function setRaiseExceptionOnStart($raise)
Inherited

final public function getHasFutureStarted()
Inherited

final public function canResolve()
Inherited

private function endFuture()
Inherited