Docs For Class ASwitch

Class ASwitch

Description

Implements interfaces:

IHost

abstarct class ASwitch

A switchek absztrakt ősosztálya. Minden switchet ebből az osztályból kell származtatni.

author: Lefi
version: 1.0
copyright: Copyright © 2008, Lefi Created on 2008.03.21.
abstract:

Located in /network/active_elements/ASwitch.php (line 68)

AActiveElement
   |
   --ASwitch

Direct descendents

Class	Description
CSwitchZte	class CSwitchZte
CSwitchCisco	class CSwitchCisco
CSwitchSwh	class CSwitchSwh
CSwitchHuawei	class CSwitchHuawei

Variable Summary

CArpTable $arpTable

int $id

array $interfaces

array $macList

CSNMPInterface $snmpInterface

unknown_type $telnetInterface

array $trunkPorts

string $type

string $uplinkPort

Method Summary

ASwitch __construct (array $switchData)

void addHostToPort ( $host, string $port, [boolean $checkArp = true])

CArpTable getArpTable ()

IHost getHostByPort (string $port)

int getId ()

array getInterfaces ()

int getMacCountOnPort (int $port)

array getMacList ()

array getMacListOnPort (string $port)

string getPortByMac (string $mac)

CSNMPInterface getSnmpInterface ()

CTelnetInterface &getTelnetInterface ()

string getTelnetLogin ()

string getTelnetPassword ()

array getTrunkPorts ()

string getType ()

string getUplinkPort ()

boolean hasChild ()

void loadArp (array $vlans)

void readArpTable ()

array readInterfaces ()

array readMacListByVlan (int $vlan)

int readPortByMac (string $mac)

array readTrunkPorts ()

void readType ()

IHost removeHostFromPort (string $port)

void setId (int $id)

void setInterfaces (array $interfaces)

void setMacList ( &$macList)

void setSnmpInterface ( $snmpInterface)

void setUplinkPort (string $port)

string toString ()

Variables

CArpTable $arpTable = NULL (line 73)

A switch ARP táblája.

access: private

int $id = NULL (line 95)

A switch adatbázis kulcsa.

access: private

array $interfaces = NULL (line 79)

Az eszköz portjai. A tömb indexei az interfész azonosítók.

A tömb elemei pedig a portokra csatlakoztatott IHost példányok.

access: private

array $macList = NULL (line 89)

A switchen keresendő MAC címek listája.

access: private

CSNMPInterface $snmpInterface = NULL (line 106)

Az SNMP kezelést megvalósító osztály példánya.

access: private

unknown_type $telnetInterface = NULL (line 111)

Telnet hozzáférést biztosító osztály egy példánya.

access: private

array $trunkPorts = array() (line 84)

A trunk portok listája.

access: private

string $type = NULL (line 101)

A switch típusa

access: private

string $uplinkPort = NULL (line 117)

Annak a portnak az azonosítója amellyel a szülő eszközhöz csatlakozik.

access: private

Inherited Variables

Inherited from AActiveElement

AActiveElement::$ip
AActiveElement::$mac
AActiveElement::$parent
AActiveElement::$parentPort

Methods

Constructor __construct (line 128)

Konstruktor

todo: A példányosításkor figyelni kell a paraméter helyességre ({@param $switchData},MAC cím), különben kivétel EInvalidParameterException váltódik ki amit le kell kezelni!
throws: EInvalidParameterException Ha a kötelező paraméterek nincsenek rendben.
access: public

ASwitch __construct (array $switchData)

array $switchData: A switch adatai tartalmazó tömb.

Redefined in descendants as:

CSwitchZte::__construct() : Konstruktor
CSwitchCisco::__construct() : Konstruktor
CSwitchL3Cisco::__construct() : Konstruktor.
CSwitchSwh::__construct() : Konstruktor
CSwitchHuawei::__construct() : Konstruktor

addHostToPort (line 276)

A switch adott portjához rendel egy hosztot.

Ha $checkArp értéke true, akkor egyeztet, hogy az ARP táblában a $port-nak megfelelő interfészhez van e rendelve a hoszt MAC címe. Ha a $checkArp értéke false akkor úgy is hozzáadható a hosz az adott porthoz, hogy az nem szerepel, vagy másik porthoz van rendelve az ARP táblában.

throws: ENoSuchPortException Akkor váltódik ki, ha nemlétező interfészre hivatkozik a $port paraméter.
throws: EDoubleMacException Akkor váltódik ki, ha a $host már hozzá lett rendelve valamelyik interfészhez.
throws: EInvalidPortException Akkor váltódik ki, ha a hoszt MAC címe az ARP táblában nem ahhoz az interfészhez van rendelve, amelyre a $port paraméter mutat.
access: public

void addHostToPort ( $host, string $port, [boolean $checkArp = true])

IHost $host: A hoszt.
string $port: Az interfész amire a hoszt kapcsolódik.
boolean $checkArp: Ha TRUE akkor a metódus ellenőrzi a hosztot az ARP táblában.

getArpTable (line 230)

Hozzáférést biztosít az ARP táblához

return: A switch ARP táblájának referenciája
access: public

CArpTable getArpTable ()

getHostByPort (line 258)

Visszadja az adott interfészen lévő hosztot.

return: Az interfészre kapcsolt hoszt, vagy NULL.
throws: ENoSuchPortException Kivételt dobja, ha nem létezik a $port azonosítójú interfész.
access: public

IHost getHostByPort (string $port)

string $port: Az interfész azonosítója.

getId (line 512)

Lekérdezi a switch adatbázis kulcsát.

return: A switch adatbázis kulcsa.
access: public

int getId ()

getInterfaces (line 223)

hozzáférést biztosít a switch portjainak listájához.

return: A portok listája.
access: public

array getInterfaces ()

getMacCountOnPort (line 249)

Magadja, hogy hány darab MAC cím van az adott interfészen.

return: A MAC címek darabszáma.
see: CArpTable::getMacCountOnPort
throws: ENoSuchPortException Ha nem található a keresett port az ARP táblában.
access: public

int getMacCountOnPort (int $port)

int $port: Az interfész azonosítója.

getMacList (line 317)

A switchen keresett MAC címek listájához nyújt hozzáférést.

return: A MAC címek listája.
access: public

array getMacList ()

getMacListOnPort (line 333)

Visszaadja az adott porthoz bejegyzett MAC címek listáját.

return: A MAC címek listája vagy NULL.
throws: ENoSuchPortException Kivétel váltódik ki, ha nemlétező interfészre hivatkoztunk.
access: public

array getMacListOnPort (string $port)

string $port: A port azonosítója.

Redefined in descendants as:

CSwitchCisco::getMacListOnPort() : Az adott porton jelentkező MAC címek listáját adja meg.

getPortByMac (line 239)

Megkeres egy MAC címet az ARP táblában.

return: Annak az interfésznek az azonosítója, amelyen a MAC cím jelentkezik vagy NULL.
access: public

string getPortByMac (string $mac)

string $mac: A keresett MAC cím.

Redefined in descendants as:

CSwitchHuawei::getPortByMac() : Visszadja Annak a portnak az azonosítóját, amelyen az adott MAC cím szerepel.

getSnmpInterface (line 350)

Visszadaja az SNMP interfészt.

return: Az SNMP interfész példány.
access: public

CSNMPInterface getSnmpInterface ()

getTelnetInterface (line 357)

Hozzáférést ad a TELNET interfészhez

return: A telnet interfész.
access: protected

CTelnetInterface &getTelnetInterface ()

getTelnetLogin (line 364)

A telnet interfészben tárolt login nevet adja vissza.

return: Telnet login név.
access: protected

string getTelnetLogin ()

getTelnetPassword (line 371)

A telnet interfészben tárolt jelszót adja vissza.

return: Telnet jelszó.
access: protected

string getTelnetPassword ()

getTrunkPorts (line 310)

Visszadja a trunk portok listáját.

return: A trunk portok listája.
access: public

array getTrunkPorts ()

getType (line 504)

A switch típus leírásához nyújt hozzáférést.

return: A switch típus leírását tartalmazó string.
access: public

string getType ()

getUplinkPort (line 468)

Visszaadja hogy a switch melyik portján keresztül kapcsolódik a szülő eszközhöz.

return: A port azonosítója.
access: public

string getUplinkPort ()

hasChild (line 440)

Megadja, hogy a switch rendelkezik e legalább egy gyermek eszközzel.

return: Ha van alárendelve hoszt akkor true, egyébként false.
access: public

boolean hasChild ()

Redefinition of:

AActiveElement::hasChild(): Megadja, hogy az aktív eszközre van e kapcsolva gyermek eszköz.

loadArp (line 378)

Az ARP táblát tölti fel MAC címekkel.

access: protected

void loadArp (array $vlans)

array $vlans: A vlan azonosítókat tartalmazó tömb.

readArpTable (line 418)

Kiolvassa a teljes ARP táblát.

abstract:
access: protected

void readArpTable ()

Redefined in descendants as:

CSwitchZte::readArpTable() : Kiolvassa a teljes ARP táblát.
CSwitchCisco::readArpTable() : Kiolvassa a teljes ARP táblát.
CSwitchSwh::readArpTable() : Kiolvassa a teljes ARP táblát.
CSwitchHuawei::readArpTable() : Beolvassa a teljes ARP táblát.

readInterfaces (line 431)

Kiolvassa az switch fizikai interfészeit SNMP segítségével.

return: Az interfészek neveit tartalmazó tömb.
abstract:
access: protected

array readInterfaces ()

Redefined in descendants as:

CSwitchZte::readInterfaces() : Kiolvassa az switch fizikai interfészeit SNMP segítségével.
CSwitchCisco::readInterfaces() : A fizikai interfészek listáját olvassa ki az eszközből SNMP segítségével.
CSwitchSwh::readInterfaces() : Kiolvassa az switch fizikai interfészeit SNMP segítségével.
CSwitchHuawei::readInterfaces() : Kigyűjti az eszköz portjainak listáját SNMP segítségével.

readMacListByVlan (line 426)

Az adott VLAN-ból jövő MAC címeket olvassa ki az eszközből.

return: A MAC címek listáját tartalmazó tömb. A tömb indexei a MAC címek,az értékek, pedig az interfészek, amelyen a MAC cím jelentkezik.
abstract:
throws: ENoSuchVlanException Ha nincs az eszközön az adott VLAN.
access: protected

array readMacListByVlan (int $vlan)

int $vlan: A VLAN azonosítója.

Redefined in descendants as:

CSwitchZte::readMacListByVlan() : Az adott VLAN-ból jövő MAC címeket olvassa ki az eszközből.
CSwitchCisco::readMacListByVlan() : Az adott VLAN-ból jövő MAC címeket olvassa ki az eszközből.
CSwitchSwh::readMacListByVlan() : Az adott VLAN-ból jövő MAC címeket olvassa ki az eszközből.
CSwitchHuawei::readMacListByVlan() : Az eszközből kiolvassa az adott VLAN-ban jelentkező MAC címeket.

readPortByMac (line 414)

Kiolvassa az eszközből, hogy az adott MAC cím melyik porton jelentkezik.

return: Az interfész száma, vagy 0.
abstract:
access: protected

int readPortByMac (string $mac)

string $mac: A keresett MAC cím.

Redefined in descendants as:

CSwitchZte::readPortByMac() : Kiolvassa az eszközből, hogy az adott MAC cím melyik porton jelentkezik.
CSwitchCisco::readPortByMac() : Kiolvassa az eszközből, hogy az adott MAC cím melyik porton jelentkezik.
CSwitchSwh::readPortByMac() : Kiolvassa az eszközből, hogy az adott MAC cím melyik porton jelentkezik.
CSwitchHuawei::readPortByMac() : SNMP-én keresztül kiolvassa a switchből, hogy az adott MAC cím melyik porton jelentkezik.

readTrunkPorts (line 408)

Kiolvassa az eszközből a trunk portok listáját.

return: A trunk portok listája.
abstract:
access: protected

array readTrunkPorts ()

Redefined in descendants as:

CSwitchZte::readTrunkPorts() : Kiolvassa az eszközből a trunk portok listáját.
CSwitchCisco::readTrunkPorts() : Kiolvassa az eszközből a trunk portok listáját.
CSwitchSwh::readTrunkPorts() : Kiolvassa az eszközből a trunk portok listáját.
CSwitchHuawei::readTrunkPorts() : A trönk portokat olvassa ki a switchből

readType (line 435)

SNMP segítségével kiolvassa a switch típusát.

abstract:
access: protected

void readType ()

Redefined in descendants as:

CSwitchZte::readType() : SNMP segítségével kiolvassa az eszköz típusát.
CSwitchCisco::readType() : SNMP segítségével kiolvassa az eszköz típusát.
CSwitchSwh::readType() : SNMP segítségével kiolvassa az eszköz típusát.
CSwitchHuawei::readType() : A switch típusát olvassa ki SNMP segítségével.

removeHostFromPort (line 300)

Eltávolít egy hosztott az adott interfészről.

return: Az eltávolított hoszt.
throws: ENoSuchPortException Akkor váltódik ki, ha nemlétező interfészre hivatkozik a $port paraméter.
access: public

IHost removeHostFromPort (string $port)

string $port: Az interfész azonosítója.

setId (line 520)

Beállítja a switch adatbázis kulcsát.

access: public

void setId (int $id)

int $id: A switch adatbázis kulcsa.

setInterfaces (line 209)

A switch portjait állítja be.

access: public

void setInterfaces (array $interfaces)

array $interfaces

setMacList (line 324)

Bellítja az eszközön keresett MAC címek listáját.

access: protected

void setMacList ( &$macList)

array &$macList: & $macList

setSnmpInterface (line 343)

Beállítja az SNMP interfészt.

access: public

void setSnmpInterface ( $snmpInterface)

CSNMPInterface $snmpInterface: Az SNMP kapcsolat példánya.

setUplinkPort (line 456)

Beállítja, hogy a switch melyik portjával kapcsolódik a szülő eszközhöz.

throws: ENoSuchPortException
access: public

void setUplinkPort (string $port)

string $port: A fizikai interfész azonosítója.

toString (line 477)

A switch adatait reprezentáló szöveget adja vissza HTML formátumban.

Amennyiben van switchhez kapcsolt eszköz, annak az adatait is hozzáfűzi.

return: Az adatokat tartalmazó HTML formátumú string.
access: public

string toString ()

Redefinition of:

AActiveElement::toString(): Az aktív eszköz adatait tartalmazó stringet adja meg HTML formátumban.

Inherited Methods

Inherited From AActiveElement

AActiveElement::getIP()
AActiveElement::getMac()
AActiveElement::getParent()
AActiveElement::getParentPort()
AActiveElement::hasChild()
AActiveElement::setIP()
AActiveElement::setMac()
AActiveElement::setParent()
AActiveElement::setParentPort()
AActiveElement::toString()

Documentation generated on Mon, 05 May 2008 13:17:43 +0200 by phpDocumentor 1.4.0