-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Documenting the non-blocking features of the Process component #2430
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,15 +26,16 @@ a command in a sub-process:: | |
$process = new Process('ls -lsa'); | ||
$process->setTimeout(3600); | ||
$process->run(); | ||
|
||
// executes after the the command finishes | ||
if (!$process->isSuccessful()) { | ||
throw new \RuntimeException($process->getErrorOutput()); | ||
} | ||
|
||
print $process->getOutput(); | ||
|
||
The :method:`Symfony\\Component\\Process\\Process::run` method takes care | ||
of the subtle differences between the different platforms when executing the | ||
command. | ||
The component takes care of the subtle differences between the different platforms | ||
when executing the command. | ||
|
||
When executing a long running command (like rsync-ing files to a remote | ||
server), you can give feedback to the end user in real-time by passing an | ||
|
@@ -51,6 +52,41 @@ anonymous function to the | |
echo 'OUT > '.$buffer; | ||
} | ||
}); | ||
|
||
.. versionadded:: 2.1 | ||
The non-blocking feature was added in 2.1. | ||
|
||
You can also start the subprocess and then let it run asynchronously, retrieving | ||
output and the status in your main process whenever you need it. Use the | ||
:method:`Symfony\\Component\\Process\\Process::start` method to start an asynchronous | ||
process, the :method:`Symfony\\Component\\Process\\Process::isRunning` method | ||
to check if the process is done and the | ||
:method:`Symfony\\Component\\Process\\Process::getOutput` method to get the output:: | ||
|
||
$process = new Process('ls -lsa'); | ||
$process->start(); | ||
|
||
while ($process->isRunning()) { | ||
// waiting for process to finish | ||
} | ||
|
||
echo $process->getOutput(); | ||
|
||
You can also wait for a process to end if you started it asynchronously and | ||
are done doing other stuff:: | ||
|
||
$process = new Process('ls -lsa'); | ||
$process->start(); | ||
|
||
// do other things | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
$process->wait(function ($type, $buffer) { | ||
if ('err' === $type) { | ||
echo 'ERR > '.$buffer; | ||
} else { | ||
echo 'OUT > '.$buffer; | ||
} | ||
}); | ||
|
||
If you want to execute some PHP code in isolation, use the ``PhpProcess`` | ||
instead:: | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
duplicate
the
.@weaverryan a change was needed...