CommandReader Class Reference

Public Member Functions
	__construct ()
	shutdown ()
	quit ()
	getLine ()
	run ()
	getThreadName ()
Public Member Functions inherited from Thread
	getClassLoader ()
	setClassLoader (\ClassLoader $loader=null)
	registerClassLoader ()
	start (int $options=PTHREADS_INHERIT_ALL)
	quit ()
	getThreadName ()
Public Member Functions inherited from Thread
	getCreatorId ()
	getThreadId ()
	isJoined ()
	isStarted ()
	join ()
	start (int $options=PTHREADS_INHERIT_ALL)
Public Member Functions inherited from Threaded
	chunk ($size, bool $preserve=false)
	count ()
	isRunning ()
	isTerminated ()
	merge ($from, $overwrite=true)
	notify ()
	notifyOne ()
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	pop ()
	run ()
	shift ()
	synchronized (\Closure $function, $args=null)
	wait ($timeout)
	getRefCount ()
	addRef ()
	delRef ()
	isGarbage ()

Data Fields
const	TYPE_READLINE = 0
const	TYPE_STREAM = 1
const	TYPE_PIPED = 2

Protected Attributes
	$buffer
Protected Attributes inherited from Thread
	$classLoader
	$isKilled = false

Additional Inherited Members
Static Public Member Functions inherited from Thread
static	getCurrentThread ()
static	getCurrentThreadId ()
Static Public Member Functions inherited from Threaded
static	extend ($obj)

Constructor & Destructor Documentation

__construct()

__construct

(

)

CommandReader constructor.

                                 {
        $this->buffer = new \Threaded;

        $opts = getopt("", ["disable-readline"]);
        if((extension_loaded("readline") and !isset($opts["disable-readline"]) and !$this->isPipe(STDIN))){
            $this->type = self::TYPE_READLINE;
        }

        $this->start();
    }

Member Function Documentation

getLine()

getLine

(

)

Reads a line from console, if available. Returns null if not available

Returns

string|null

                             {
        if($this->buffer->count() !== 0){
            return $this->buffer->shift();
        }

        return null;
    }

getThreadName()

getThreadName

(

)

Returns

string

                                   {
        return "Console";
    }

quit()

quit

(

)

                          {
        $wait = microtime(true) + 0.5;
        while(microtime(true) < $wait){
            if($this->isRunning()){
                usleep(100000);
            }else{
                parent::quit();
                return;
            }
        }

        $message = "Thread blocked for unknown reason";
        if($this->type === self::TYPE_PIPED){
            $message = "STDIN is being piped from another location and the pipe is blocked, cannot stop safely";
        }

        throw new \ThreadException($message);
    }

run()

run

(

)

                         {
        if($this->type !== self::TYPE_READLINE){
            $this->initStdin();
        }

        while(!$this->shutdown and $this->readLine()) ;

        if($this->type !== self::TYPE_READLINE){
            global $stdin;
            fclose($stdin);
        }

    }

shutdown()

shutdown

(

)

                              {
        $this->shutdown = true;
    }

Field Documentation

$buffer

$buffer

protected

TYPE_PIPED

const TYPE_PIPED = 2

TYPE_READLINE

const TYPE_READLINE = 0

TYPE_STREAM

const TYPE_STREAM = 1

---

The documentation for this class was generated from the following file:

• src/pocketmine/command/CommandReader.php