Podrobný popis API

Sekvenční diagram komunikace se systémem Maatrix

 

 interface ext app sl    interface maatrix sl  interface sequence
  interface A B X sl  

call – spuštění komunikační služby za pomoci externí aplikace.

A (call) oslovení externí aplikací - volání komunikační služby

B (call_response) – potvrzení spuštění komunikační služby / informace o chybách

X (summary) - asynchronní informace o ukončení běhu komunikační služby Maatrix (pokud byla v A vyžádána) - touto zprávou systém Maatrix aktivně sděluje externí aplikaci, že došlo k ukončení běhu komunikační služby a externí aplikaci předává výsledky tohoto běhu.

Pokud aktivní zprávu ze systému Maatrix nepovoluje zvolený typ rozhraní a nebo pokud nebyla ve větě A vyžádána (SendSummary), může externí aplikace zjistit stav a výsledky běhu komunikační služby dotazy (věta E).

  interface C D sl  

app_set – nastavení parametrů v průběhu již spuštěné komunikační služby (zatím není v provozu)

C (app_set) – nastavení z externí aplikace

(app_set_response) – response – potvrzení nastavení / informace o chybách

  interface E F Y r1 sl  

app_query – externí aplikace se dotazuje na vlastnosti spuštěné komunikační služby nebo na stav popř. výsledek ukončené komunikační služby

E (app_query)– dotaz externí aplikace na běh komunikační služby Maatrix. Systém Maatrix umožňuje opakované dotazy na běh komunikační služby - prodleva mezi jednotlivými dotazy musí být nejméně 10 vteřin - častější dotazy budou ignorovány.

F (app_query_response)– synchronní odpověď systému Maatrix

Y (app_query_response)– asynchronní odpověď systému Maatrix (pokud byla v E vyžádána - viz hodnota WaitFor)

  interface G H sl  

cancel – externí aplikace zastavuje běh komunikačního procesu

G (cancel) – žádost o ukončení komunikačního procesu

H (cancel_response)– response – potvrzení ukončení procesu / informace o chybách

  interface I J sl  

m_set – nastavení externí aplikace na základě aktivity komunikačního procesu (zatím není v provozu)

I (m_set) – nastavení ze systému Maatrix

J (m_set_response) - response – potvrzení nastavení / informace o chybách
  interface K L Z sl  

m_query – systém Maatrix se dotazuje externí aplikace (zatím není v provozu)

K (m_query) – dotaz systému Maatrix

L (m_query_response) – synchronní odpověď externí aplikace

Z (m_query_response) - asynchronní odpověď externí aplikace

Pro základní činnosti interface je tedy nejdůležitější zpráva A (a k ní odpověď B) spouštějící službu Maatrix z externí aplikace a pak buď zpráva E (a k ní odpověď F), kterou se cyklicky externí aplikace dotazuje systému Maatrix, jestli již byla dokončena spuštěná komunikační služba (pokud byla dokončena, tak je výsledek předán zprávou F), a nebo zpráva X, kterou systém Maatrix aktivně sděluje externí aplikaci, že byla komunikační služba ukončena. Způsob informování o ukončení běhu komunikační služby Maatrix je tedy dvojí (věty E/F a věta X) a závisí na zvoleném typu rozhraní.