Konfigurace uživatelských procedur rozhraní API
Uživatelská procedura rozhraní API je modul kódu (soubor .dll, který sami zadáte a který je spuštěn bezprostředně před voláními MQI nebo po nich.
Informace o této úloze
Když produkt IBM® MQ obdrží volání z programu do jednoho z jeho vstupních bodů API, bude produkt IBM MQ volat vaši uživatelskou proceduru rozhraní API. Uživatelská procedura rozhraní API je spuštěna před spuštěním MQI nebo něm. Závisí to na tom, jak je uživatelská procedura nakonfigurována.
Můžete nakonfigurovat, aby nebyla volána žádná, jedna nebo mnoho uživatelských procedur a můžete také nakonfigurovat pořadí, ve kterém má být více nakonfigurovaných uživatelských procedur voláno. V systémech Windows a Linux® (platformy x86 a x86-64) lze nakonfigurovat uživatelské procedury API pomocí produktu IBM MQ Explorer. Podrobnosti konfigurace jsou uloženy v souborech .ini.
- Konfigurace uživatelské procedury rozhraní API v IBM MQ Explorer.
- Přepsání běžné uživatelské procedury rozhraní API lokální uživatelskou procedurou rozhraní API.
- Běžné (ApiExitCommon)
- Jedna sada definic na počítač. Po spuštění správce front jsou ve správci front načteny a použity nadefinované uživatelské procedury API (pokud jsou nějaké nadefinované). Běžné uživatelské procedury rozhraní API lze konfigurovat v dialogovém okně vlastností produktu IBM MQ. Běžné uživatelské procedury se zobrazují v tabulce Lokální uživatelské procedury rozhraní API v dialogovém okně vlastností každého lokálního správce front.
- Šablona (ApiExitTemplate)
- Jedna sada definic na počítač. Při vytvoření správce front jsou uživatelské procedury rozhraní API, které jsou zde nadefinované (pokud jsou nějaké nadefinované), zkopírovány do nově vytvořeného správce front jako lokální uživatelské procedury. Uživatelské procedury rozhraní API šablony lze konfigurovat v dialogovém okně vlastností produktu IBM MQ.
- Lokální (ApiExitLocal)
- Jedna sada definic na správce front. Po spuštění správce front přepíší všechny nadefinované uživatelské procedury API běžné uživatelské procedury, pokud mají shodné atributy Název a pokud bylo přepsání specifikováno. Pokud je přepsána běžná uživatelská procedura rozhraní API, nebude uloženo žádné z polí běžné definice, a to ani v případě, že byla přiřazena hodnota volitelnému atributu Data. Lokální uživatelské procedury rozhraní API lze konfigurovat v dialogovém okně vlastností správce front.
Atribut | Význam | Klíč výrazu |
---|---|---|
Název | Určuje popisný název uživatelské procedury rozhraní API, který je předán uživatelské proceduře rozhraní API v poli ExitInfoName struktury MQAXP. Tento název musí být jedinečný a může obsahovat maximálně 48 znaků platných pro názvy objektů produktu IBM MQ (například názvy front). | Název |
Typ | Určuje typ uživatelské procedury: common , template , local nebo override . |
(Nejedná se o samostatný klíč sekce.) |
Pořadí | Tento atribut představuje číslo bez znaménka definující pořadí, ve kterém je tato uživatelská procedura rozhraní API volána ve vztahu k jiným uživatelským procedurám rozhraní API. Uživatelská procedura rozhraní API s nízkým pořadovým číslem je volána před uživatelskou procedurou rozhraní API s vyšším pořadovým číslem. Pořadí, v jakém jsou volány různé uživatelské procedury rozhraní API se stejným pořadovým číslem, není definováno. Mezery v číslování uživatelských procedur rozhraní API definovaných pro správce front nejsou na překážku. | Pořadí |
Modul | Určuje modul, který obsahuje kód uživatelské procedury rozhraní API. Pokud pole obsahuje název modulu včetně úplné cesty, je použit beze změny. Pokud toto pole obsahuje pouze název modulu, je modul vyhledán stejnou metodou jako uživatelské procedury kanálu, tj. pomocí hodnoty v poli Výchozí cesta uživatelské procedury na stránce Uživatelské procedury v dialogového okna vlastností správce front. | Modul |
Funkce | Určuje název vstupního bodu funkce do modulu, který obsahuje kód uživatelské procedury rozhraní API. Tímto vstupním bodem je funkce MQ_INIT_EXIT. Délka pole je omezena hodnotou MQ_EXIT_NAME_LENGTH. | Funkce |
Data | Pokud je tento atribut zadán, jsou odebrány mezery na začátku a na konci, zbývající řetězec je zkrácen na 32 znaků a výsledek je předán uživatelské proceduře v poli ExitData struktury MQAXP. Není-li atribut určen, je uživatelské proceduře předáno v poli ExitData struktury MQAXP 32 mezer. | Data |