AWOT-Online Client-palvelut
_____________________________________________________________________________
Versio 1.2 29.8.2002
Versio 1.1 20.8.2002
Versio 1.0 10.8.2002
Jukka.Inkeri@Awot.biz


Kaikki pyynnöt on muotoa
    avaa socket
    pyydä palvelu
    sulje socket
paitsi tuo DB SHOWALL OPEN, jossa jää socket auki.

Protokolla on hyvin simppeli eli vaikka telnetillä voi testata (tietysti).

Kaikki pyynnöt ovat tekstirivejä (newline erotin) muodossa
palvelu arg1 arg2 [argv...  ]

kaikkiin sanomiin palvelin vastaa
    OK
     tai
    ERR virheteksti
Jos vastaus on ERR, niin palvelin sulkee socketin.
Jos vastausrivi alkaa #-merkillä,on se vain kommenttirivi, kannattaa
tallentaa lokeihin.

_______________________________________________________________
Avaussanoma (esittely) on aina muotoa
_______________________________________________________________
eventid hostname hostip email gsm

johon palvelin vastaa OK.

eventid LISTEVENT on varattu erikoiskäyttöön.

Koska protokolla olettaa, että ensin esittelyssä kerrotaan kisa
ja palvelupyynnössä pyydetään listaus, niin kisaluetteloa
pyydettäessä kisaksi annetaan varattu kisanimi LISTEVENT ja
palvelupyynnöksi myös LISTEVENT.

_______________________________________________________________
Protokolla
_______________________________________________________________
Istunnnon rakenne on aine:
-merkinnät:
	-> palvelimelle
	<- palvelimelta
	[ ] voi olla, ei pakollinen

->Avaussanoma (esittely)
<-OK-sanoma
->Palvelupyyntö
<-OK-sanoma
<-Vastausotsikko
<-Vastausdatarivit
<-OK-lopetus


_______________________________________________________________
OK-Sanoma
_______________________________________________________________
	OK [jotain tekstiä].
	esim. OK 1200
_______________________________________________________________
OK-lopetus
_______________________________________________________________
	OK end [jotain tekstiä].
	Esim. OK end 1300

_______________________________________________________________
Vastausotsikko
_______________________________________________________________
	Palvelupyyntö kenttäerotin kenttien_määrä.
       	Palvelupyyntö ilman argumenttejä. 
	Esim. LISTEVENT vastaus on
		LISTEVENT ; 2
	Usein vastausotsikon perässä tulee kommenttiviestinä
	palvelypyynnön kopio.


_______________________________________________________________
Palvelypyynnöt
_______________________________________________________________
Seuraavat palvelupyyntöluokat on määritelty
LISTEVENT	kilpailuluettelo
DB		tapahtumakannan palvelut
RESULT		tulosluettelo palvelut
START		lähtöluettelo
PROS		palauttaa palveluprosessin tunnuksen (debug)

_______________________________________________________________
DB Kannan käsittely
_______________________________________________________________
DB SHOWALL OPEN    
	anna koko kanta ja laita uudet sitä mukaan
        kun tulee uusia tapahtumia. Socket jää auki !!!
	Jos tulee vaste ATT sek, niin 
	- socket tulee sulkea ja muutokset tulee
	  kysyä DB STATUS kyselyllä ja sen jälkeen pyytää
  	  uudet tapahtumat pyynnöllä DB rivialkaen 0

DB SHOWALL CLOSE 
	anna koko kanta

DB 1000 0    
	anna riviltä 1000 alkaen loppukanta

DB 1000 1200    
	anna rivit 1000-1200

DB STATUS    
	anna tiedoston koko merkkeinä, rivimäärä ja aikaleima

_______________________________________________________________
LISTEVENT Kantaluettelo
_______________________________________________________________
LISTEVENT
	Vastaus on muotoa
	eventid;eventname

_______________________________________________________________
RESULT Tulosluettelot
_______________________________________________________________
RESULT LISTCLASSTREE         
	Sarja-matka luettelo eli mitä tuloksia on saatavilla ko.kisasta.
RESULT LISTCLASS
	Sarjaluettelo eli mistä sarjoista on tuloksia.
RESULT LISTCLASSDIST sarja
	Matkaluettelo sarjasta eli mistä kohtaa rataa
	on ko. sarjasta saatavissa tuloksia.
RESULT STATUS sarja matka    
	Tulostiedoston koko ja aikaleima eli voi katsoa onko tapahtunut
        muutoksia.
RESULT RESULT sarja matka    
	Tulokset.
RESULT ONLINE sarja matka  [polltime]
	Seurataan vain sarjaa eli kun on muutoksia, tulee koko sarjan
        tulokset uudelleen.
	Oletus on, että tilanne tarkastetaan 30 s välein, mutta
	muuttamalla polltime arvoa, voidaan harventaa
	tarkastelujaksoa. Useimmissa sarjoissa riittäisi varmaan n. 120.

Tulosluettelo tulee aina valmiiksi paremmuusjärjestyksessä.

_______________________________________________________________
START Lähtölistat 
_______________________________________________________________
START LISTCLASS            
		luettelo sarjoista, joista saa lähtölistan.
		vastaus on muotoa
		START ; 1
		H21A;
		D21A;

		Jos vastaus onkin vain
		ONELIST
		niin lähtölista on vain yksi kokonainen lista, jonka
		saa pyynnöllä START LIST

START sarja     lähtölista sarjasta.

START LIST	
		voi olla myös yksi kokonainen lähtölista muodossa:
		
		SARJA;H21A;5,5;
		113000;31;Varis Pekka;OH;
		113200;32;Jukka Inkeri;KR;
		SARJA;H21B;
		...


_______________________________________________________________
INFO viestit
_______________________________________________________________
	Datarivien seassa voi tulla tiedote, joka alkaa
	INFO ja sitä seuraa tekstiä.

	Esim:
	INFO Valitse Valikko ja aloita seuranta uudelleen.