Docs For Class CallerBasic

Description

This is an Abstract class representing Methods all Thread-Calling classes must implement

it also has some Concrete methods

abstract:

Direct descendents

Class	Description
AjThread	The Ajax Thread Calling Class
CliThread	Cli Thread Calling Class
SocThread	The Socket Calling Class This Class uses PHP Sockets to connect to server and launch a PHP Script/Thread it Extends CallerBasic and implelemts it's Abstract functions

Variable Summary

int $pos

Method Summary

static void Join (Array $ArrIds, ComBasic $ComH)

CallerBasic __construct (string $url, string $params, Process $MothProcess)

string Get (string $name)

int GetID ()

string GetState ()

void Go ()

void Set (string $name, string $value)

void SetParams (string $Npr)

Variables

int $pos (line 57)

used for Calculating Thread id

access: protected

Methods

static Join (line 150)

This is a Static Function used to Join Another Thread/s (Wait for them to finish) These Threads MUST give a sign they finished (using TClien Class)

void Join (Array $ArrIds, ComBasic $ComH)

Array $ArrIds: The Array of Thread ID's to be joined
ComBasic $ComH

Constructor __construct (line 73)

CallerBasic Constructor , it must be explicily called from clasese extending it (PHP OOP issue)

Preparing Counter for generating ID's , and Setting Thread state

CallerBasic __construct (string $url, string $params, Process $MothProcess)

string $url: Location of Thread to be called , it's format is Threading-class dependent
string $params: Parameters to be passed to the called thread
Process $MothProcess: Process to which thread will belong

Redefined in descendants as:

AjThread::__construct() : Ajax Class Constructor
CliThread::__construct() : Cli-Thread Class Constuctor Just Pick Arguments and tidy them
SocThread::__construct() : SocThread Constructor

Get (line 104)

takes the name of a Communication Varaible and returns it's value

string Get (string $name)

string $name

GetID (line 113)

Return the thread ID

int GetID ()

GetState (line 122)

return Thread State as read from Communication Class Varaible

string GetState ()

Go (line 132)

This is a void function with no arguments

it's used to Launch / Call the Thread

abstract:
access: public

void Go ()

Redefined in descendants as:

AjThread::Go() : Ajax-Thread Calling Specific Thread Launching function
CliThread::Go() : Cli-Thread Calling Specific Launching Function
SocThread::Go() : Socket Thread Calling Specific Launching Function

Set (line 94)

Associates / Sets Name $name with the Value $value it can be used to create a Name or reeassign it (change it's value )

This function Just wrapps the Communication Class Setting function

void Set (string $name, string $value)

string $name
string $value

SetParams (line 140)

A void function with one argument

This Function is used to Change the Thread Arguments before Calling/Launching it

abstract:
access: public

void SetParams (string $Npr)

string $Npr

Redefined in descendants as:

AjThread::SetParams() : Ajax-Thread Calling Specific Parameters Setting
CliThread::SetParams() : Cli-Thread Calling Specific Parameters Setting Function
SocThread::SetParams() : Socket Thread Calling Specific Parameters Setting Function