"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerProcessCommunication.html" (20 Jan 2013, 18854 Bytes) of package /linux/www/SitemapCreator.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <?xml version="1.0" encoding="iso-8859-1"?>
    2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3   <html xmlns="http://www.w3.org/1999/xhtml">
    4         <head>
    5             <!-- template designed by Marco Von Ballmoos -->
    6             <title>Docs For Class PHPCrawlerProcessCommunication</title>
    7             <link rel="stylesheet" href="../media/stylesheet.css" />
    8             <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
    9         </head>
   10         <body>
   11             <div class="page-body">         
   12 <h2 class="class-name">Class PHPCrawlerProcessCommunication</h2>
   13 
   14 <a name="sec-description"></a>
   15 <div class="info-box">
   16     <div class="info-box-title">Description</div>
   17     <div class="nav-bar">
   18                     <span class="disabled">Description</span> |
   19                                                     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   20                         |                                           <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   21                         
   22                     </div>
   23     <div class="info-box-body">
   24                 <!-- ========== Info from phpDoc block ========= -->
   25 <p class="short-description">Class containing methods for process handling and communication</p>
   26         <p class="notes">
   27             Located in <a class="field" href="_libs---PHPCrawler---ProcessCommunication---PHPCrawlerProcessCommunication.class.php.html">/libs/PHPCrawler/ProcessCommunication/PHPCrawlerProcessCommunication.class.php</a> (line <span class="field">8</span>)
   28         </p>
   29         
   30                 
   31         <pre></pre>
   32     
   33             </div>
   34 </div>
   35 
   36 
   37 
   38     <a name="sec-var-summary"></a>
   39     <div class="info-box">
   40         <div class="info-box-title">Variable Summary</span></div>
   41         <div class="nav-bar">
   42             <a href="#sec-description">Description</a> |
   43                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
   44                             | 
   45                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   46                             
   47                                 </div>
   48         <div class="info-box-body">
   49             <div class="var-summary">
   50                                                                                                                                                                                                                                 <div class="var-title">
   51                     <span class="var-type">mixed</span>
   52                     <a href="#$crawlerStatus" title="details" class="var-name">$crawlerStatus</a>
   53                 </div>
   54                                                                 <div class="var-title">
   55                     <span class="var-type">mixed</span>
   56                     <a href="#$crawler_uniqid" title="details" class="var-name">$crawler_uniqid</a>
   57                 </div>
   58                                                                 <div class="var-title">
   59                     <span class="var-type">mixed</span>
   60                     <a href="#$multiprocess_mode" title="details" class="var-name">$multiprocess_mode</a>
   61                 </div>
   62                                                                 <div class="var-title">
   63                     <span class="var-type"><a href="../phpcrawl/PHPCrawlerDocumentInfoQueue.html">PHPCrawlerDocumentInfoQueue</a></span>
   64                     <a href="#$resumtion_enabled" title="details" class="var-name">$resumtion_enabled</a>
   65                 </div>
   66                                                                 <div class="var-title">
   67                     <span class="var-type">mixed</span>
   68                     <a href="#$working_directory" title="details" class="var-name">$working_directory</a>
   69                 </div>
   70                                             </div>
   71         </div>
   72     </div>
   73 
   74     <a name="sec-method-summary"></a>
   75     <div class="info-box">
   76         <div class="info-box-title">Method Summary</span></div>
   77         <div class="nav-bar">
   78             <a href="#sec-description">Description</a> |
   79                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
   80                  
   81                 |
   82                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
   83         </div>
   84         <div class="info-box-body">         
   85             <div class="method-summary">
   86                                                                                                                                                                                                                                                                                 
   87                                                 <div class="method-definition">
   88                                             <span class="method-result">PHPCrawlerProcessCommunication</span>
   89                                         <a href="#__construct" title="details" class="method-name">__construct</a>
   90                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$crawler_uniqid</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$multiprocess_mode</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$working_directory</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$enable_resumtion</span>)
   91                                     </div>
   92                                                                 <div class="method-definition">
   93                                             <span class="method-result">bool</span>
   94                                         <a href="#childProcessAlive" title="details" class="method-name">childProcessAlive</a>
   95                                         ()
   96                                     </div>
   97                                                                 <div class="method-definition">
   98                                             <span class="method-result">array</span>
   99                                         <a href="#getChildPIDs" title="details" class="method-name">getChildPIDs</a>
  100                                             ([<span class="var-type">int</span>&nbsp;<span class="var-name">$process_count</span> = <span class="var-default">null</span>])
  101                                     </div>
  102                                                                 <div class="method-definition">
  103                                             <span class="method-result"><a href="../phpcrawl/PHPCrawlerStatus.html">PHPCrawlerStatus</a></span>
  104                                         <a href="#getCrawlerStatus" title="details" class="method-name">getCrawlerStatus</a>
  105                                         ()
  106                                     </div>
  107                                                                 <div class="method-definition">
  108                                             <span class="method-result">void</span>
  109                                         <a href="#killChildProcesses" title="details" class="method-name">killChildProcesses</a>
  110                                         ()
  111                                     </div>
  112                                                                 <div class="method-definition">
  113                                             <span class="method-result">void</span>
  114                                         <a href="#registerChildPID" title="details" class="method-name">registerChildPID</a>
  115                                             (<span class="var-type">int</span>&nbsp;<span class="var-name">$pid</span>)
  116                                     </div>
  117                                                                 <div class="method-definition">
  118                                             <span class="method-result">void</span>
  119                                         <a href="#setCrawlerStatus" title="details" class="method-name">setCrawlerStatus</a>
  120                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerStatus.html">PHPCrawlerStatus</a></span>&nbsp;<span class="var-name">$crawler_status</span>)
  121                                     </div>
  122                                                                 <div class="method-definition">
  123                                             <span class="method-result">void</span>
  124                                         <a href="#updateCrawlerStatus" title="details" class="method-name">updateCrawlerStatus</a>
  125                                             (<span class="var-type"><a href="../phpcrawl/PHPCrawlerDocumentInfo.html">PHPCrawlerDocumentInfo</a></span>&nbsp;<span class="var-name">$PageInfo</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$abort_reason</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$first_content_url</span> = <span class="var-default">null</span>])
  126                                     </div>
  127                                 </div>
  128         </div>
  129     </div>      
  130 
  131     <a name="sec-vars"></a>
  132     <div class="info-box">
  133         <div class="info-box-title">Variables</div>
  134         <div class="nav-bar">
  135             <a href="#sec-description">Description</a> |
  136                                         <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  137                         
  138             
  139                                         | 
  140                                     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  141                             
  142                     </div>
  143         <div class="info-box-body">
  144             <a name="var$crawlerStatus" id="$crawlerStatus"><!-- --></A>
  145 <div class="oddrow">
  146 
  147     <div class="var-header">
  148         <span class="var-title">
  149             <span class="var-type">mixed</span>
  150             <span class="var-name">$crawlerStatus</span>
  151                         (line <span class="line-number">16</span>)
  152         </span>
  153     </div>
  154 
  155     <!-- ========== Info from phpDoc block ========= -->
  156     <ul class="tags">
  157                 <li><span class="field">access:</span> protected</li>
  158             </ul>
  159     
  160     
  161         
  162         
  163 
  164 </div>
  165 <a name="var$crawler_uniqid" id="$crawler_uniqid"><!-- --></A>
  166 <div class="evenrow">
  167 
  168     <div class="var-header">
  169         <span class="var-title">
  170             <span class="var-type">mixed</span>
  171             <span class="var-name">$crawler_uniqid</span>
  172                         (line <span class="line-number">10</span>)
  173         </span>
  174     </div>
  175 
  176     <!-- ========== Info from phpDoc block ========= -->
  177     <ul class="tags">
  178                 <li><span class="field">access:</span> protected</li>
  179             </ul>
  180     
  181     
  182         
  183         
  184 
  185 </div>
  186 <a name="var$multiprocess_mode" id="$multiprocess_mode"><!-- --></A>
  187 <div class="oddrow">
  188 
  189     <div class="var-header">
  190         <span class="var-title">
  191             <span class="var-type">mixed</span>
  192             <span class="var-name">$multiprocess_mode</span>
  193                         (line <span class="line-number">12</span>)
  194         </span>
  195     </div>
  196 
  197     <!-- ========== Info from phpDoc block ========= -->
  198     <ul class="tags">
  199                 <li><span class="field">access:</span> protected</li>
  200             </ul>
  201     
  202     
  203         
  204         
  205 
  206 </div>
  207 <a name="var$resumtion_enabled" id="$resumtion_enabled"><!-- --></A>
  208 <div class="evenrow">
  209 
  210     <div class="var-header">
  211         <span class="var-title">
  212             <span class="var-type"><a href="../phpcrawl/PHPCrawlerDocumentInfoQueue.html">PHPCrawlerDocumentInfoQueue</a></span>
  213             <span class="var-name">$resumtion_enabled</span>
  214              = <span class="var-default"> false</span>          (line <span class="line-number">23</span>)
  215         </span>
  216     </div>
  217 
  218     <!-- ========== Info from phpDoc block ========= -->
  219 <p class="short-description">Flag indicating whether resumtion is activated</p>
  220     <ul class="tags">
  221                 <li><span class="field">access:</span> protected</li>
  222             </ul>
  223     
  224     
  225         
  226         
  227 
  228 </div>
  229 <a name="var$working_directory" id="$working_directory"><!-- --></A>
  230 <div class="oddrow">
  231 
  232     <div class="var-header">
  233         <span class="var-title">
  234             <span class="var-type">mixed</span>
  235             <span class="var-name">$working_directory</span>
  236                         (line <span class="line-number">14</span>)
  237         </span>
  238     </div>
  239 
  240     <!-- ========== Info from phpDoc block ========= -->
  241     <ul class="tags">
  242                 <li><span class="field">access:</span> protected</li>
  243             </ul>
  244     
  245     
  246         
  247         
  248 
  249 </div>
  250                         
  251         </div>
  252     </div>
  253     
  254     <a name="sec-methods"></a>
  255     <div class="info-box">
  256         <div class="info-box-title">Methods</div>
  257         <div class="nav-bar">
  258             <a href="#sec-description">Description</a> |
  259                                                             <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  260                                                                     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  261                         
  262         </div>
  263         <div class="info-box-body">
  264             <A NAME='method_detail'></A>
  265 
  266 <a name="method__construct" id="__construct"><!-- --></a>
  267 <div class="evenrow">
  268     
  269     <div class="method-header">
  270         <span class="method-title">Constructor __construct</span> (line <span class="line-number">33</span>)
  271     </div> 
  272     
  273     <!-- ========== Info from phpDoc block ========= -->
  274 <p class="short-description">Initiates a new PHPCrawlerProcessCommunication-object.</p>
  275     <ul class="tags">
  276                 <li><span class="field">access:</span> public</li>
  277             </ul>
  278     
  279     <div class="method-signature">
  280         <span class="method-result">PHPCrawlerProcessCommunication</span>
  281         <span class="method-name">
  282             __construct
  283         </span>
  284                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$crawler_uniqid</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$multiprocess_mode</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$working_directory</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$enable_resumtion</span>)
  285             </div>
  286     
  287             <ul class="parameters">
  288                     <li>
  289                 <span class="var-type">string</span>
  290                 <span class="var-name">$crawler_uniqid</span><span class="var-description">: UID of the crawler</span>          </li>
  291                     <li>
  292                 <span class="var-type">int</span>
  293                 <span class="var-name">$multiprocess_mode</span><span class="var-description">: Multprocess-mode the crawler is running (one of the PHPCrawlerMultiProcessModes-constants)</span>           </li>
  294                     <li>
  295                 <span class="var-type">string</span>
  296                 <span class="var-name">$working_directory</span><span class="var-description">: Working-dir of the crawler</span>           </li>
  297                     <li>
  298                 <span class="var-type">bool</span>
  299                 <span class="var-name">$enable_resumtion</span><span class="var-description">: TRUE if resumption of crawling-processes should be possible</span>           </li>
  300                 </ul>
  301         
  302             
  303     </div>
  304 <a name="methodchildProcessAlive" id="childProcessAlive"><!-- --></a>
  305 <div class="oddrow">
  306     
  307     <div class="method-header">
  308         <span class="method-title">childProcessAlive</span> (line <span class="line-number">192</span>)
  309     </div> 
  310     
  311     <!-- ========== Info from phpDoc block ========= -->
  312 <p class="short-description">Checks wehther any child-processes a (still) running.</p>
  313     <ul class="tags">
  314                 <li><span class="field">access:</span> public</li>
  315             </ul>
  316     
  317     <div class="method-signature">
  318         <span class="method-result">bool</span>
  319         <span class="method-name">
  320             childProcessAlive
  321         </span>
  322                 ()
  323             </div>
  324     
  325         
  326             
  327     </div>
  328 <a name="methodgetChildPIDs" id="getChildPIDs"><!-- --></a>
  329 <div class="evenrow">
  330     
  331     <div class="method-header">
  332         <span class="method-title">getChildPIDs</span> (line <span class="line-number">152</span>)
  333     </div> 
  334     
  335     <!-- ========== Info from phpDoc block ========= -->
  336 <p class="short-description">Returns alls PIDs of all running child-processes</p>
  337     <ul class="tags">
  338                 <li><span class="field">return:</span> Numeric array conatining the PIDs</li>
  339                 <li><span class="field">access:</span> public</li>
  340             </ul>
  341     
  342     <div class="method-signature">
  343         <span class="method-result">array</span>
  344         <span class="method-name">
  345             getChildPIDs
  346         </span>
  347                     ([<span class="var-type">int</span>&nbsp;<span class="var-name">$process_count</span> = <span class="var-default">null</span>])
  348             </div>
  349     
  350             <ul class="parameters">
  351                     <li>
  352                 <span class="var-type">int</span>
  353                 <span class="var-name">$process_count</span><span class="var-description">: If set, this function tries to get the child-PIDs until the gievn number of PIDs                            was determinated.</span>            </li>
  354                 </ul>
  355         
  356             
  357     </div>
  358 <a name="methodgetCrawlerStatus" id="getCrawlerStatus"><!-- --></a>
  359 <div class="oddrow">
  360     
  361     <div class="method-header">
  362         <span class="method-title">getCrawlerStatus</span> (line <span class="line-number">64</span>)
  363     </div> 
  364     
  365     <!-- ========== Info from phpDoc block ========= -->
  366 <p class="short-description">Returns/reads the current crawler-status</p>
  367     <ul class="tags">
  368                 <li><span class="field">return:</span> The current crawlerstatus as a PHPCrawlerStatus-object</li>
  369                 <li><span class="field">access:</span> public</li>
  370             </ul>
  371     
  372     <div class="method-signature">
  373         <span class="method-result"><a href="../phpcrawl/PHPCrawlerStatus.html">PHPCrawlerStatus</a></span>
  374         <span class="method-name">
  375             getCrawlerStatus
  376         </span>
  377                 ()
  378             </div>
  379     
  380         
  381             
  382     </div>
  383 <a name="methodkillChildProcesses" id="killChildProcesses"><!-- --></a>
  384 <div class="evenrow">
  385     
  386     <div class="method-header">
  387         <span class="method-title">killChildProcesses</span> (line <span class="line-number">178</span>)
  388     </div> 
  389     
  390     <!-- ========== Info from phpDoc block ========= -->
  391 <p class="short-description">Kills all running child-processes</p>
  392     <ul class="tags">
  393                 <li><span class="field">access:</span> public</li>
  394             </ul>
  395     
  396     <div class="method-signature">
  397         <span class="method-result">void</span>
  398         <span class="method-name">
  399             killChildProcesses
  400         </span>
  401                 ()
  402             </div>
  403     
  404         
  405             
  406     </div>
  407 <a name="methodregisterChildPID" id="registerChildPID"><!-- --></a>
  408 <div class="oddrow">
  409     
  410     <div class="method-header">
  411         <span class="method-title">registerChildPID</span> (line <span class="line-number">135</span>)
  412     </div> 
  413     
  414     <!-- ========== Info from phpDoc block ========= -->
  415 <p class="short-description">Registers the PID of a child-process</p>
  416     <ul class="tags">
  417                 <li><span class="field">access:</span> public</li>
  418             </ul>
  419     
  420     <div class="method-signature">
  421         <span class="method-result">void</span>
  422         <span class="method-name">
  423             registerChildPID
  424         </span>
  425                     (<span class="var-type">int</span>&nbsp;<span class="var-name">$pid</span>)
  426             </div>
  427     
  428             <ul class="parameters">
  429                     <li>
  430                 <span class="var-type">int</span>
  431                 <span class="var-name">$pid</span><span class="var-description">: The IPD</span>            </li>
  432                 </ul>
  433         
  434             
  435     </div>
  436 <a name="methodsetCrawlerStatus" id="setCrawlerStatus"><!-- --></a>
  437 <div class="evenrow">
  438     
  439     <div class="method-header">
  440         <span class="method-title">setCrawlerStatus</span> (line <span class="line-number">48</span>)
  441     </div> 
  442     
  443     <!-- ========== Info from phpDoc block ========= -->
  444 <p class="short-description">Sets/writes the current crawler-status</p>
  445     <ul class="tags">
  446                 <li><span class="field">access:</span> public</li>
  447             </ul>
  448     
  449     <div class="method-signature">
  450         <span class="method-result">void</span>
  451         <span class="method-name">
  452             setCrawlerStatus
  453         </span>
  454                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerStatus.html">PHPCrawlerStatus</a></span>&nbsp;<span class="var-name">$crawler_status</span>)
  455             </div>
  456     
  457             <ul class="parameters">
  458                     <li>
  459                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerStatus.html">PHPCrawlerStatus</a></span>
  460                 <span class="var-name">$crawler_status</span><span class="var-description">: The status to set</span>           </li>
  461                 </ul>
  462         
  463             
  464     </div>
  465 <a name="methodupdateCrawlerStatus" id="updateCrawlerStatus"><!-- --></a>
  466 <div class="oddrow">
  467     
  468     <div class="method-header">
  469         <span class="method-title">updateCrawlerStatus</span> (line <span class="line-number">85</span>)
  470     </div> 
  471     
  472     <!-- ========== Info from phpDoc block ========= -->
  473 <p class="short-description">Updates the status of the crawler</p>
  474     <ul class="tags">
  475                 <li><span class="field">access:</span> public</li>
  476             </ul>
  477     
  478     <div class="method-signature">
  479         <span class="method-result">void</span>
  480         <span class="method-name">
  481             updateCrawlerStatus
  482         </span>
  483                     (<span class="var-type"><a href="../phpcrawl/PHPCrawlerDocumentInfo.html">PHPCrawlerDocumentInfo</a></span>&nbsp;<span class="var-name">$PageInfo</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$abort_reason</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$first_content_url</span> = <span class="var-default">null</span>])
  484             </div>
  485     
  486             <ul class="parameters">
  487                     <li>
  488                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerDocumentInfo.html">PHPCrawlerDocumentInfo</a></span>
  489                 <span class="var-name">$PageInfo</span><span class="var-description">: The PHPCrawlerDocumentInfo-object of the last received document                                                   or NULL if no document was received.</span>            </li>
  490                     <li>
  491                 <span class="var-type">int</span>
  492                 <span class="var-name">$abort_reason</span><span class="var-description">: One of the PHPCrawlerAbortReasons::ABORTREASON-constants if the crawling-process                                                   should get aborted, otherwise NULL</span>         </li>
  493                     <li>
  494                 <span class="var-type">string</span>
  495                 <span class="var-name">$first_content_url</span><span class="var-description">: The first URL some content was found in (or NULL if no content was found so far).</span>            </li>
  496                 </ul>
  497         
  498             
  499     </div>
  500                         
  501         </div>
  502     </div>
  503 
  504 
  505     <p class="notes" id="credit">
  506         Documentation generated on Sun, 20 Jan 2013 21:18:50 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
  507     </p>
  508     </div></body>
  509 </html>