Abstract Class ComBasic

Description

This is an Abstract class representing Methods all Communication classes must implement

  • abstract:

Located in /Com/Com.php (line 15)


	
			
Direct descendents
Class Description
 class FileCom The Flat File Communication Class
 class MyCom The MySQL Communication Class
 class ShmopCom The Shared Memory Communication Class
Method Summary
 void Clear ()
 bool Exist (string $name)
 string Get (string $name)
 void Init ()
 void Set (string $name, string $value)
Methods
Clear (line 29)

This is a void function with no arguments

it's used to clear any space equipied by the communication class

  • abstract:
  • access: public
void Clear ()

Redefined in descendants as:
Exist (line 58)

Value returning function with arguments

used to check if a Communication Varaible Name exists or not

  • return: A Boolean value indicating whether this Communication Varaible Name Exists or not
  • abstract:
  • access: public
bool Exist (string $name)
  • string $name: the Communication Varaible Name

Redefined in descendants as:
  • FileCom::Exist() : Flat File Communication Specific Exisctance Checking Function
  • MyCom::Exist() : MySQL Communication Specific Existance Checking Function
  • ShmopCom::Exist() : Shared Memory Communication Specific Existance Checking Function
Get (line 50)

Value returning function with arguments

takes the name of a Communication Varaible and returns it's value All Names are allowed BUT the following :- "Read","Thread_#_State" where # is any number chosing any of these two reserved Names Could Crash the thing

  • return: the value of Communication Varaible $name (if it exists) or null if not
  • abstract:
  • access: public
string Get (string $name)
  • string $name: the Communication Varaible Name

Redefined in descendants as:
Init (line 22)

This is a void function with no arguments

it's called by the Threading class to provide initialization to the communication class

  • abstract:
  • access: public
void Init ()

Redefined in descendants as:
Set (line 39)

void function with arguments

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

  • todo: Add a return type to indicate whether value properly set or not
  • abstract:
  • access: public
void Set (string $name, string $value)
  • string $name: the Communication Varaible name
  • string $value: Communication Varaible value

Redefined in descendants as:

Documentation generated on Fri, 01 Aug 2008 05:54:11 +0300 by phpDocumentor 1.4.1