Konfigurowanie wyjść funkcji API
Wyjście funkcji API jest to moduł kodu w postaci pliku .dll, który jest dostarczany przez użytkownika i jest uruchamiany tuż przed wywołaniami interfejsu MQI lub tuż po nich.
Informacje o zadaniu
Gdy program IBM® MQ odbiera wywołanie z programu do jednego z jego punktów wejścia interfejsu API, program IBM MQ wywołuje wyjście funkcji API. Wyjście funkcji API jest uruchamiane przed lub po uruchomieniu interfejsu MQI (zgodnie z konfiguracją wyjścia określoną przez użytkownika).
Użytkownik może skonfigurować wiele wyjść, które mają być wywoływane, jedno takie wyjście lub żadnego, może również skonfigurować kolejność wywoływania wielu wyjść. W systemach Windows i Linux® (platformyx86 i x86-64 ) można skonfigurować wyjścia funkcji API za pomocą programu IBM MQ Explorer. Szczegóły konfiguracji są zapisywane w plikach.ini.
- Skonfiguruj wyjście funkcji API w produkcie IBM MQ Eksplorator.
- Nadpisz wspólne wyjście funkcji API przy użyciu lokalnego wyjścia funkcji API.
- Wspólne (ApiExitCommon)
- Jeden zbiór definicji na komputer. Po uruchomieniu menedżera kolejek zdefiniowane wyjścia funkcji API (jeśli zostały zdefiniowane) są czytane i stosowane do menedżera kolejek. Konfigurowanie wspólnych wyjść funkcji API w oknie dialogowym właściwości IBM MQ . Wyjścia wspólne są wyświetlane w oknie dialogowym właściwości każdego menedżera kolejek, w tabeli Wyjścia lokalne funkcji API.
- Szablonowe (ApiExitTemplate)
- Jeden zbiór definicji na komputer. Podczas tworzenia menedżera kolejek zdefiniowane tutaj wyjścia funkcji API (jeśli jakieś zostały zdefiniowane) są kopiowane do nowo tworzonego menedżera kolejek jako wyjścia lokalne. Skonfiguruj wyjścia funkcji API szablonu w oknie dialogowym właściwości IBM MQ .
- Lokalne (ApiExitLocal)
- Jeden zbiór definicji na menedżera kolejek. Podczas uruchamiania menedżera kolejek zdefiniowane wyjścia funkcji API przesłaniają wyjścia wspólne, jeśli wartości ich atrybutów Nazwa są takie same i jeśli określono nadpisywanie. Jeśli wspólne wyjście funkcji API zostanie przesłonięte, żadne z pól definicji wspólnej nie zostanie zapisane, nawet jeśli opcjonalny atrybut Dane ma przypisaną wartość. Konfigurowanie lokalnych wyjść funkcji API odbywa się za pomocą okna dialogowego właściwości menedżera kolejek.
Atrybut | Znaczenie | Klucz sekcji |
---|---|---|
Nazwa | Określa opis wyjścia funkcji API przekazywany do wyjścia funkcji API w polu ExitInfoName w strukturze MQAXP. Nazwa ta musi być unikalna i ograniczona do długości 48 znaków i musi zawierać tylko te znaki, które są poprawne dla nazwy obiektów IBM MQ , takich jak nazwy kolejek. | Nazwa |
Typ | Określa typ wyjścia: common , template , local lub override . |
(Brak odrębnego klucza sekcji) |
Kolejność | Atrybut będący wartością liczbową bez znaku, za pomocą którego definiowana jest kolejność wywoływania tego wyjścia funkcji API w porównaniu z pozostałymi wyjściami funkcji API. Wywołanie wyjścia funkcji API z niskim numerem kolejnym następuje przed wywołaniem wyjścia funkcji API z wyższym numerem kolejnym. Kolejność wywoływania różnych wyjść funkcji API z takim samym numerem kolejnym jest niezdefiniowana. Dopuszczalne jest istnienie przerw w numerach kolejnych wyjść funkcji API zdefiniowanych dla menedżera kolejek. | Kolejność |
Moduł | Służy do określenia modułu zawierającego kod dla wyjścia funkcji API. Jeśli w polu znajduje się pełna nazwa ścieżki do modułu, jest ona używana w takiej postaci. Jeśli w polu znajduje się tylko nazwa modułu, wyszukiwanie modułu odbywa się przy użyciu takiej samej metody, jak wyszukiwanie wyjść kanału, to znaczy za pomocą wartości określonej w polu Domyślna ścieżka wyjść na stronie Wyjścia w oknie dialogowym Właściwości menedżera kolejek. | Moduł |
Funkcja | Określa nazwę punktu wejścia funkcji do modułu zawierającego kod dla wyjścia funkcji API. Punktem wejścia jest funkcja MQ_INIT_EXIT. Wielkość tego pola jest ograniczona do wartości MQ_EXIT_NAME_LENGTH. | Funkcja |
Dane | Jeśli określono ten atrybut, usuwane są odstępy początkowe i końcowe, a pozostały łańcuch jest obcinany do 32 znaków. Następnie wynik jest przekazywany do wyjścia znajdującego się w polu ExitData w strukturze MQAXP. Jeśli atrybut ten nie zostanie określony, do wyjścia znajdującego się w polu ExitData w strukturze MQAXP przekazywana jest domyślna wartość stanowiąca 32 znaki odstępu. | Dane |