contrib/DocBlox/Parallel/WorkerPipe.php

Show: inherited
Table of Contents

DocBlox

PHP Version 5

Author
Mike van Riel  
Category
DocBlox  
Copyright
2010-2011 Mike van Riel / Naenius (http://www.naenius.com)  
License
MIT  
Link
http://docblox-project.org  
Package
Parallel  

\DocBlox_Parallel_WorkerPipe

Package: Parallel

Class that represents a named pipe for a Worker.

This class manages the named pipe for a worker and is able to push and pull specific data to facilitate IPC (interprocess communication).

Author
Mike van Riel  
Category
DocBlox  
License
MIT  
Link
http://docblox-project.org  

Properties

Propertyprotectedstring  $path= ''

Path to the pipe
Details
Type
string
Propertyprotected\DocBlox_Parallel_Worker  $worker= ''

worker class that is associated

Methods

methodpublic__construct( \DocBlox_Parallel_Worker $worker ) : void

Initializes the named pipe.

Parameters
Name Type Description
$worker \DocBlox_Parallel_Worker

Associated worker.

methodpublic__destruct( ) : void

If the named pipe was not cleaned up, do so now.

methodpublicpull( ) : void

Pull the worker data into the named pipe.

methodpublicpush( ) : void

Push the worker data back onto the worker and release the pipe.

methodprotectedreadPipeContents( ) : array

Returns the unserialized contents of the pipe.

Returns
Type Description
array
methodprotectedrelease( ) : void

Releases the pipe.

methodprotectedwritePipeContents( ) : void

Convenience method to show relation to readPipeContents.

Documentation was generated by DocBlox 0.18.1.