Klient pro XML Socket Multiuser Server - eClever

Director demo (200 kB) Director - chat demo (200 kB) Authorware demo (200 kB)

Popis a možnosti využití
XTRA dmmXSC (XSC=XML Socket Client) je socket klient pro připojení k XML Socket Multiuser Serveru - eClever, který umožňuje v produktech Director a Authorware od firmy Macromedia vytvářet víceuživatelské aplikace, hry pro více hráčů, chaty atd. Můžete také vytvářet Web-CD aplikace a využívat všech výhod víceuživatelského prostředí.

Knihovna podporuje
• Director 8 a novější
• Authorware 6 a novější

Historie

Seznam metod

Popis metod
-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ErrorDialog(dialog: boolean)
Pomocí této funkce můžeme nastavit, zda se v okamžiku vzniku chyby v XTRA má zobrazit dialogové okno s výpisem této chyby. Toto nastavení funguje pouze v Autor módu a zjednoduší nám ladění aplikací. Pokud dialogové okno nechcete nastavit, můžete chyby sledovat pomocí funkce errorMsg().

Parametry
Funkce má jeden parametr dialog, který je typu boolean. Má-li parametr dialog hodnotu true, tak se při každé chybě v XTRA zobrazí dialogové okno s výpisem chyby. Pro nastavení parametru dialog na hodnotu false se dialogové okno nezobrazí. Defaultně je nastaveno dialog=false.

Příklad - Director
sprite(1).errorDialog(true)

Příklad - Authorware
CallSprite(@"XML Socket Client"; #errorDialog; true)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=ErrorLog(logFile: string, logSave: boolean)
Pomocí této funkce můžeme nastavit, zda se v okamžiku vzniku chyby v XTRA má tato chyba uložit do textového log souboru. Toto nastavení funguje pouze v Autor módu a zjednoduší nám ladění aplikací.

Parametry
Funkce má 2 parametry. Parametr logFile je název log souboru, do kterého chceme ukládat chyby. Parametr logSave je typu boolean. Má-li parametr logSave hodnotu true, tak se při každé chybě v XTRA uloží chyba do souboru logFile. Pro nastavení parametru logSave na hodnotu false se nebude nic ukládat. Defaultně je nastaveno logSave=false.

Příklad - Director
sprite(1).errorLog(the pathName&"log.txt", true)

Příklad - Authorware
CallSprite(@"XML Socket Client"; #errorLog; FileLocation ^ "log.txt"; true)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=connectToServer( url: string, port:string)
Tato metoda slouží k připojení k XML Socket Serveru.

Parametry
Tato metoda má 2 parametry. URL je adresa počítače, na kterém běží XML Socket Server, a port je číslo portu, na kterém tento server naslouchá. XTRA se umí připojit pouze k portům s číslem vyšším než 1024 a tento port nesmí být obsazen jinou aplikací.

Příklad - Director
Chcete-li se např. připojit k XML Socket Serveru, který běží na stejném počítači jako klient a naslouchá na portu 2727, stačí zadat
sprite(1).connectToServer("localhost", 2727)

Příklad - Authorware
CallSprite(@"XML Socket Client"; #connectToServer ; "127.0.0.1"; 2727)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=disconnectFromServer( )
Tato metoda ukončí spojení s XML Socket Serverem.

Parametry
Tato metoda nemá žádné parametry.

Příklad - Director
sprite(1).disconnectFromServer()

Příklad - Authorware
CallSprite(@"XML Socket Client"; #disconnectFromServer)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

void=send( xml: string)
Tato metoda odešle na XML Socket Server požadavek ve formátu XML.

Parametry
Tato metoda má parametr xml, který je typu string, a zadáváme zde požadavek, který chceme odeslat na server. Požadavek musí být ve správném formátu, který je schopen XML Socket Server přijmout.

Příklad - Director
sprite(1).send("<protocol><roomList sid='7'/></protocol>")

Příklad - Authorware
CallSprite(@"XML Socket Client"; #send ; "<protocol><roomList sid='7'/></protocol>")

-----------------------------------------------------------------------------------------------------------------------------------------------------------

Popis vlastností
-----------------------------------------------------------------------------------------------------------------------------------------------------------

list=xtraVersion
Pomocí vlastnosti xtraVersion můžeme zjistit informace o XTRA dmmXSC. Vlastnost vrací hodnoty ve formátu Abstract Data Types.
[#fileType: "Xtra (32)",
 #CompanyName: "Studio dmm",
 #FileDescription: "XML Socket Client",
 #FileVersion: "1.2.0.17",
 #InternalName: "dmmXSC.x32",
 #LegalCopyRight: "© 1992-2005 Studio dmm",
 #LegalTradeMarks: "Studio dmm",
 #OriginalFileName: "dmmXSC.x32",
 #productName: "dmmXSC.x32",
 #productVersion: "1.2.0.0"]

Význam jednotlivých vrácených položek je zřejmý a není nutné je podrobněji popisovat.

Příklad - Director
version=sprite(1).xtraVersion

Příklad - Authorware
version:=CallSprite(@"XML Socket Client"; #xtraVersion)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

string=errorMsg
Pomocí vlastnosti errorMsg získáme text chyby, která nastala při práci s XTRA. Pokud operace proběhla v pořádku, funkce vrací prázdný řetězec.

Příklad - Director
sprite(1).connect("localhost", 2277)
error=sprite(1).errorMsg
if error="" then
  ...
end if

Příklad - Authorware
error:=CallSprite(@"XML Socket Client"; #errorMsg)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

boolean=isNoError
Pomocí vlastnosti isNoError zjistíme, zda určitá operace proběhla bez chyby. Pokud k chybě nedošlo, je vrácena hodnota true.

Příklad - Director
sprite(1).connect("localhost", 2277)
if sprite(1).isNoError then
  ...
end if

Příklad - Authorware
isError:=CallSprite(@"XML Socket Client"; #isNoError)

-----------------------------------------------------------------------------------------------------------------------------------------------------------

Popis událostí
-----------------------------------------------------------------------------------------------------------------------------------------------------------

Connected me
Událost je vyvolána v okamžiku, kdy se podařilo klientovi přihlásit na XML Socket Server.

Příklad - Director
on connected me
     put "Connected"
end

Příklad - Authorware
Podívejte se na demo verzi, type=event

-----------------------------------------------------------------------------------------------------------------------------------------------------------

Disconnected me
Událost je vyvolána v okamžiku, kdy byl klient odpojen od XML Socket Serveru.

Příklad - Director
on disconnected me
     put "Disconnected"
end

Příklad - Authorware
Podívejte se na demo verzi, type=event

-----------------------------------------------------------------------------------------------------------------------------------------------------------

DataXML me, xml
Událost je vyvolána v okamžiku, kdy XML Socket Server pošle klientovi zprávu. Tato událost je vyvolána vždy, když dojde jakákoli zpráva od XML Socket Serveru. Tato zpráva je celá vrácena v proměnné xml.
.
Příklad - Director
on dataXML me, xml
     put xml
end

Příklad - Authorware
Podívejte se na demo verzi, type=event

-----------------------------------------------------------------------------------------------------------------------------------------------------------

ResponseXML me, xml, action, sid, errorCode
Událost je vyvolána v okamžiku, kdy XML Socket Server pošle klientovi zprávu typu "response". Událost vrací hodnoty xml, action, sid a errorCode. Xml, action, sid jsou typu string, errorCode je typu integer. Popis a význam proměnných naleznete v protokolu pro používání XML Socket Multiuser Serveru.

Pozn. Souběžně s touto událostí je samozřejmě také vyvolána událost dataXML.

Příklad - Director
on responseXML me, xml, action, sid, errorCode
     put xml
     put action
     put sid
     put errorCode
end

Příklad - Authorware
Podívejte se na demo verzi, type=event

-----------------------------------------------------------------------------------------------------------------------------------------------------------

ReceivedXML me, xml, action, sentFrom
Událost je vyvolána v okamžiku, kdy XML Socket Server pošle klientovi zprávu typu "received". Událost vrací hodnoty xml, action a sentFrom. Xml, action a sentFrom jsou typu string. Popis a význam proměnných naleznete v protokolu pro používání XML Socket Multiuser Serveru.

Pozn. Souběžně s touto událostí je samozřejmě také vyvolána událost dataXML.

Příklad - Director
on receivedXML me, xml, action, sentFrom
     put xml
     put action
     put sentFrom
end

Příklad - Authorware
Podívejte se na demo verzi, type=event