Docs For Class ShmopCom

Description

The Shared Memory Communication Class

it extends the ComBasic Class and Implement it's Abstract Methods

ComBasic
   |
   --ShmopCom

Variable Summary

int $id

int $MemKey

SimpleMutex $MuxH

int $perms

PlainArrayHandler $RecHandler

int $size

Method Summary

ShmopCom ShmopCom ([string $Shn = 0])

void Clear ()

void Delete (string $name)

boolean Exist (string $name)

string Get (string $name)

unknown GetAll ()

void GetSize ()

string Gget (string $name)

void Gset (string $name, string $value)

void Init ()

void Set (string $name, string $value)

Variables

int $id (line 40)

Shared Memory block id (shmid)

access: public

int $MemKey (line 46)

Shared Memory block Key

access: public

SimpleMutex $MuxH (line 53)

an Instance of the Sync Class

todo: Add an abstract Sync Class of which type the var will be
access: public

int $perms = 0777 (line 34)

Shared Memory Block Permissions

access: public

PlainArrayHandler $RecHandler (line 59)

an Instance of the Writting Methodology Class

access: public

int $size = 1000 (line 65)

The Default size of the Shared memory block

access: public

Methods

Constructor ShmopCom (line 80)

The Shared Memory Communication Class Constructor

This class is called in two manners :- 1) Intializing Communication from parent thread here it's called like : $asd=new ShmopCom() and Block size can be changed latter BUT before Init is called by Process (Which is very important according to your needs as it's Constant )

2) From a called thread to start Communication with other threads ( in same process ) :$asd=new ShmopCom($Shn) where $Shn is the Shared Memory block id which must be passed from mother thread to called threads

ShmopCom ShmopCom ([string $Shn = 0])

string $Shn

Clear (line 197)

Shared Memory Communication Specific Clearing Function

it removes Communication Shared Memory Block to clear any used space

void Clear ()

Redefinition of:

ComBasic::Clear(): This is a void function with no arguments

Delete (line 187)

This is a class Spacefic Deleting function it writes to the Shared Memory Block the Values returned from Writting Methodolgy class Deleting function

void Delete (string $name)

string $name

Exist (line 173)

Shared Memory Communication Specific Existance Checking Function

This function uses the Writting Methodolgy Class to do the Job directly (NO Sync. bounds)

boolean Exist (string $name)

string $name

Redefinition of:

ComBasic::Exist(): Value returning function with arguments

Get (line 139)

Shared Memory Communication Specific Getting Function

This function Encapsulates Getting values through Chosen Sync Class

return: the value of Communication Varaible $name (if it exists) or null if not

string Get (string $name)

string $name

Redefinition of:

ComBasic::Get(): Value returning function with arguments

GetAll (line 208)

This function is specific to PlainArray Writting class it returns all contents , here it reads the Shared Memory Block and returns it

unknown GetAll ()

GetSize (line 177)

void GetSize ()

Gget (line 161)

This is the Value Getting function it wrraps the Writting Methodolgy Class Getting function

return: the value of Communication Varaible $name (if it exists) or null if not

string Gget (string $name)

string $name

Gset (line 150)

This is the Class Specific Setting function it writes to the Shared Memory Block the Values returned from Writting Methodolgy class Setting function

void Gset (string $name, string $value)

string $name
string $value

Init (line 103)

Shared Memory Communication Specific Init Function

(For pupose of this function review ComBasic abstract class documentation)

For the ShmopCom class the role of this function is to create the shared memory block used for communication , it just picks a random key and keep iterating to find an idle one

void Init ()

Redefinition of:

ComBasic::Init(): This is a void function with no arguments

Set (line 127)

Shared Memory Communication Specific Setting Function

This function Encapsulates Setting values through Chosen Sync Class

void Set (string $name, string $value)

string $name
string $value

Redefinition of:

ComBasic::Set(): void function with arguments

Inherited Methods

Inherited From ComBasic

ComBasic::Clear()
ComBasic::Exist()
ComBasic::Get()
ComBasic::Init()
ComBasic::Set()