XML Socket Server - eClever - • XML protokol

Jak server pracuje?
Celá činnost serveru je v podstatě jednoduchá:
1. Klient se jménem např. client1 pošle na server zprávu určenou klientovi se jménem client2 v určitém tvaru, např.

<protocol>
   <userMsg sendTo="client2">
        <data game="27"></data>
   </userMsg>
</protocol>

2. Server přepošle klientovi se jménem client2 zprávu ve tvaru

<protocol> 
    <received action="userMsg" sentFrom="test"> 
        <data game="27"></data> 
    </received>
</protocol>

3. Server potvrdí odeslání zprávy klientovi, který zprávu odeslal. Client1 tedy dostane od serveru zprávu

<protocol>
    <response action="userMsg" errorCode="0"/> 
</protocol>

Obecné informace k práci se serverem
1. Ve všech požadavcích posílaných na server můžeme použít atribut sid. Tento atribut je nepovinný a vrací se klientovi, který tento atribut použil. Atribut sid slouží pouze k přesné identifikaci dotaz-odpověď. Pokud klient atribut sid nepoužil, nebude mu ani vrácen. Atribut sid musí mít vždy jedinečnou hodnotu v rámci posílaných dotazů stejného typu, abychom mohli správně atribut sid použít k rozlišení jednotlivých dotazů. To je důležité hlavně při rychlém posílání dotazů.
2. Posíláme-li zprávu klientovi, dostane ji vždy ve tvaru

<protocol>
    <received action="userMsg"> ... </received>
</protocol>

kde action identifikuje typ doručené zprávy.
3. Odpovídá-li server klientovi, který zprávu odeslal, je odpověď vždy ve tvaru

<protocol> 
    <response action="userMsg" errorCode="0" ... />
</protocol>

Kde action identifikuje typ dotazu a errorCode je návratový kód. Pokud je vráceno errorCode="0", znamená to, že se vše správně vykonalo. V opačném případě došlo k nějaké chybě. Následující tabulka uvádí seznam obecných chyb, které vrací socket server klientovi.

errorCode		Popis chyby
0		Požadovaná operace proběhla bez chyby
-1		Špatný XML formát odesílaných dat
-2		V dotazu byl použit nedefinovaný atribut
-3		Klient není přihlášen do žádné domény
-4		Klient není přihlášen do žádné místnosti
-1000		Klient není přihlášen jako administrátor