Saját szolgáltatói modul létrehozása

A saját szolgáltatói modul létrehozásához általában a következő interfészkészletet kell implementálnia.

$module::SimpleUsage()

cél
Egyszerű modulhasználati információkat jelenít meg az STDOUT-nak.

paraméterek
Egyik sem

Visszatérési érték
Egyik sem

$module::VerboseUsage()

cél
Részletes modulhasználati információkat jelenít meg az STDOUT-nak.

paraméterek
Egyik sem

Visszatérési érték
Egyik sem

$objref = $module::new(@CommandArguments)

cél
Inicializálja a szolgáltatói modul egy példányát.

paraméterek

@CommandArguments
Minden @ARGV argumentum, amelyet a ssindex.cmd nem ismer fel általános argumentumként.

Visszatérési érték
A későbbi műveletekben használható hivatkozás.

$objref->GatherFileInformation($SourcePath,$ServerHashReference)

cél
Lehetővé teszi, hogy a modul összegyűjtse a szükséges forrásindexelési információkat a $SourcePath paraméter által megadott könyvtárhoz. A modul nem feltételezheti, hogy ez a bejegyzés csak egyszer van meghívva minden objektumpéldányhoz, mivel az SSIndex többször is meghívhatja a különböző elérési utakhoz.

paraméterek

$SourcePath
Az indexelendő forrást tartalmazó helyi könyvtár.

$ServerHashReference
Hivatkozás a megadott Srcsrv.ini fájl összes bejegyzését tartalmazó kivonatra.

Visszatérési érték
Egyik sem

($VariableHashReference,$FileEntry) = $objref->GetFileInfo($LocalFile)

cél
Megadja a szükséges információkat, hogy egyetlen, adott fájlt nyerjen ki a forrásvezérlő rendszerből.

paraméterek

$LocalFile
Teljesen minősített fájlnév.

értékeket ad vissza

$VariableHashReference
A visszaadott $FileEntryértelmezéséhez szükséges változók kivonathivatkozása. Ssindex.cmd gyorsítótárazza ezeket a változókat minden olyan forrásfájlhoz, amelyet egyetlen hibakeresési fájl használ a forrásindex-adatfolyamba írt információk mennyiségének csökkentése érdekében.

$FileEntry
A forrásindex-streambe írandó fájlbejegyzés lehetővé teszi, hogy az SrcSrv kinyerje ezt a fájlt a forrásvezérlőből. A sor pontos formátuma a forrásvezérlő rendszerre jellemző.

$TextString= $objref->LongName()

cél
Leíró sztringet biztosít a végfelhasználó számára a forrásvezérlő rendszer azonosításához.

paraméterek
Egyik sem

Visszatérési érték

$TextString
A forrásvezérlő rendszer leíró neve.

@StreamVariableLines=$objref->SourceStreamVariables()

cél
Lehetővé teszi a forrásvezérlő rendszer számára, hogy forrásvezérlő-specifikus változókat adjon hozzá a forrásstreamhez minden hibakeresési fájlhoz. A mintamodulok ezt a módszert használják a szükséges EXTRACT_CMD és EXTRACT_TARGET változók írásához.

paraméterek
Egyik sem

Visszatérési érték

@StreamVariableLines
A forrásstream változóinak bejegyzéseinek listája.