<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class ZendX_Console_Process_Unix</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<script src="../media/lib/classTree.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../media/images/plus.png";
imgMinus.src = "../media/images/minus.png";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
</head>
<body>
<div class="page-body">
<h2 class="class-name"><img src="../media/images/AbstractClass_logo.png"
alt="Abstract Class"
title="Abstract Class"
style="vertical-align: middle"> ZendX_Console_Process_Unix</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ZendX_Console_Process_Unix allows you to spawn a class as a separated process</p>
<ul class="tags">
<li><span class="field">copyright:</span> Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)</li>
<li><span class="field">abstract:</span> </li>
<li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Console---Process---Unix.php.html">/Console/Process/Unix.php</a> (line <span class="field">31</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<img src="../media/images/Constructor.png" alt=" "/>
<span class="method-result">ZendX_Console_Process_Unix</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">integer</span> <span class="var-name">$puid</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span> <span class="var-name">$guid</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span> <span class="var-name">$umask</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">integer</span>
<a href="#getLastAlive" title="details" class="method-name">getLastAlive</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">integer</span>
<a href="#getPid" title="details" class="method-name">getPid</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">mixed</span>
<a href="#getVariable" title="details" class="method-name">getVariable</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#isRunning" title="details" class="method-name">isRunning</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setVariable" title="details" class="method-name">setVariable</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#start" title="details" class="method-name">start</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#stop" title="details" class="method-name">stop</a>
()
</div>
<div class="method-definition">
<img src="../media/images/AbstractMethod.png" alt=" "/>
<span class="method-result">void</span>
<a href="#_run" title="details" class="method-name">_run</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#_setAlive" title="details" class="method-name">_setAlive</a>
()
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Constructor.png" />
<span class="method-title">Constructor __construct</span> (line <span class="line-number">134</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor method</p>
<p class="description"><p>Allocates a new pseudo-thread object. Optionally, set a PUID, a GUID and a UMASK for the child process. This also initialize Shared Memory Segments for process communications.</p></p>
<ul class="tags">
<li><span class="field">throws:</span> ZendX_Console_Process_Exception When running on windows</li>
<li><span class="field">throws:</span> ZendX_Console_Process_Exception When running in web enviroment</li>
<li><span class="field">throws:</span> ZendX_Console_Process_Exception When shmop_* functions don't exist</li>
<li><span class="field">throws:</span> ZendX_Console_Process_Exception When posix_* functions don't exist</li>
<li><span class="field">throws:</span> ZendX_Console_Process_Exception When pcntl_* functions don't exist</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">ZendX_Console_Process_Unix</span>
<span class="method-name">
__construct
</span>
([<span class="var-type">integer</span> <span class="var-name">$puid</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span> <span class="var-name">$guid</span> = <span class="var-default">null</span>], [<span class="var-type">integer</span> <span class="var-name">$umask</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$puid</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$guid</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$umask</span> </li>
</ul>
</div>
<a name="methodgetLastAlive" id="getLastAlive"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">getLastAlive</span> (line <span class="line-number">324</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Read the time elapsed since the last child setAlive() call.</p>
<p class="description"><p>This method is useful because often we have a pseudo-thread pool and we need to know each pseudo-thread status. If the child executes the setAlive() method, the parent with getLastAlive() can know that child is alive.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
getLastAlive
</span>
()
</div>
</div>
<a name="methodgetPid" id="getPid"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">getPid</span> (line <span class="line-number">336</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the PID of the current pseudo-thread.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
getPid
</span>
()
</div>
</div>
<a name="methodgetVariable" id="getVariable"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">getVariable</span> (line <span class="line-number">303</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get a variable from the shared memory segment. Returns NULL if the variable doesn't exist.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
getVariable
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span> </li>
</ul>
</div>
<a name="methodisRunning" id="isRunning"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">isRunning</span> (line <span class="line-number">265</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Test if the pseudo-thread is already started.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
isRunning
</span>
()
</div>
</div>
<a name="methodsetVariable" id="setVariable"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">setVariable</span> (line <span class="line-number">286</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set a variable into the shared memory segment, so that it can accessed both from the parent and from the child process. Variable names beginning with underlines are only permitted to interal functions.</p>
<ul class="tags">
<li><span class="field">throws:</span> ZendX_Console_Process_Exception When an invalid variable name is supplied</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setVariable
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodstart" id="start"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">start</span> (line <span class="line-number">187</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Causes this pseudo-thread to begin parallel execution.</p>
<p class="description"><p>This method first checks of all the Shared Memory Segment. If okay, it forks the child process, attaches signal handler and returns immediatly. The status is set to running, and a PID is assigned. The result is that two pseudo-threads are running concurrently: the current thread (which returns from the call to the start() method) and the other thread (which executes its run() method).</p></p>
<ul class="tags">
<li><span class="field">throws:</span> ZendX_Console_Process_Exception When process forking fails</li>
<li><span class="field">throws:</span> ZendX_Console_Process_Exception When SHM segments can't be created</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
start
</span>
()
</div>
</div>
<a name="methodstop" id="stop"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">stop</span> (line <span class="line-number">244</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Causes the current thread to die.</p>
<p class="description"><p>The relative process is killed and disappears immediately from the processes list.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
stop
</span>
()
</div>
</div>
<a name="method_run" id="_run"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/AbstractMethod.png" />
<span class="method-title">_run</span> (line <span class="line-number">361</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method actually implements the pseudo-thread logic.</p>
<ul class="tags">
<li><span class="field">abstract:</span> </li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
_run
</span>
()
</div>
</div>
<a name="method_setAlive" id="_setAlive"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">_setAlive</span> (line <span class="line-number">351</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set a pseudo-thread property that can be read from parent process in order to know the child activity.</p>
<p class="description"><p>Practical usage requires that child process calls this method at regular time intervals; parent will use the getLastAlive() method to know the elapsed time since the last pseudo-thread life signals...</p></p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
_setAlive
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 14 Feb 2009 13:36:24 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
c6e871b44bbb7f63efb8491c7ba30c3c
>
files
>
8
