Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Uściślenie wymiany informacji #84

Merged
merged 6 commits into from
Mar 16, 2020
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions Dokumentacja/DefinicjeWiadomosci/messageWrapper.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,6 @@
"messageID": {
"type":"integer"
},
"timeSent": {
"type":"string",
"format":"date-time"
},
"waitUntil": {
"type":"string",
"format":"date-time"
},
"agentID": {
"type":"integer"
},
Expand Down
4 changes: 2 additions & 2 deletions Dokumentacja/DiagramyKlas/Agent.tex
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ \subsubsection{Agent}
\method[public bool]{havePiece}{Zmienna informująca czy gracz jest w posiadaniu piece'a.}
\method[{public Field[,]}]{board}{Tablica dwuwymiarowa przechowująca planszę z perspektywy gracza.}
\method[{public Tuple<int,int>}]{position}{Współrzędne pola na planszy, na którym stoi gracz.}
\method[{public List<Tuple<int,bool>>}]{waitingPlayers}{Lista id oraz informacji czy są oni liderami drużyny graczy oczekujących na odpowiedź.}
\method[{public List<int>}]{waitingPlayers}{Lista id graczy oczekujących na odpowiedź.}
\method[{public int[]}]{teamMates}{Lista identyfikatorów graczy z naszej drużyny.}
\method[private IStrategy]{strategy}{Obiekt odpowiedzialny za używaną strategię.}
\end{methods}
Expand All @@ -25,7 +25,7 @@ \subsubsection{Agent}
\method{Put()}{Metoda odkładająca fragment na planszę. Wysyła zapytanie do GM i w zależności od odpowiedzi aktualizuje stan wiedzy agenta.}
\method{BegForInfo()}{Metoda wysyłająca do GM prośbę o wymianę informacji przez innego wybranego agenta}
\method{GiveInfo()}{Metoda udzielająca informacji o rozgrywce wskazanemu graczowi.}
\method{RequestResponse()}{Metoda wywoływana na przyjście wiadomości z prośbą o wymianę informacji. Zapamiętuje parametry gracza który poprosił informację do listy \textit{waitingPlayers}}
\method{RequestResponse()}{Metoda wywoływana na przyjście wiadomości z prośbą o wymianę informacji. Zapamiętuje parametry gracza który poprosił informację do listy \textit{waitingPlayers}. W przypadku gdy ten gracz był liderem wywołuje metodę \textit{GiveInfo()}}
\method{CheckPiece()}{Metoda sprawdzająca czy fragment to fragment fikcyjny. Wysyła zapytanie do GM i w zależności od odpowiedzi aktualizuje stan wiedzy agenta.}
\method[public void]{AcceptMessage()}{Metoda pobierająca informacje od serwera komunikacyjnego.}
\method{MakeDecisionFromStrategy()}{Metoda, która wywołuje metodę z obiektu strategy. Wywoływana jest okresowo i to ona decuduje o akcjach wykonywanych przez agenta. Używa IStrategy.}
Expand Down
463 changes: 220 additions & 243 deletions Dokumentacja/DiagramyKlas/resources/Agent.eps

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions Dokumentacja/Dokumentacja.tex
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@

% Przypadki użycia
\subfile{./PrzypadkiUzycia/PrzypadkiUzycia.tex}
\subfile{./MierzenieCzasu.tex}
\subfile{./Komunikacja.tex}
\subfile{./Konfiguracje/Konfiguracje.tex}
\subfile{./DiagramyKlas/DiagramyKlas.tex}
Expand Down
16 changes: 11 additions & 5 deletions Dokumentacja/Komunikacja.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,22 @@
\section{Komunikacja}
\label{sec:komunikacja}

Komunikacja odbywa się za pośrednictwem protokołu TCP. Utrata połączenia z którymkolwiek modułem skutkuje w każdym z modułów
Komunikacja odbywa się za pośrednictwem protokołu TCP. Pierwsze 2 bajty zapisane w kolejności \texttt{little endian}
Oznaczają liczbę bajtów wiadomości do odczytania (wyłączając pierwsze dwa bajty).
Wiadomości nie powinny przekraczać długości 8 KiB. Wiadomości kodowane są w UTF-8.
Utrata połączenia z którymkolwiek modułem skutkuje w każdym z modułów
poinformowaniem użytkownika i zakończeniem działania. Wiadomości wysyłane są w formacie JSON.
Wiadomości wysyłane przez GM i Agentów opakowywane są w adapter opisujący kontekst wysyłanej wiadomości.
Pole \textit{agentID} uzupełniane jest przez serwer na podstawie. Po nawiązaniu połączenia przez Agenta z serwerem,
Pole \textit{agentID} uzupełniane jest przez serwer na podstawie jego własnego mapowania
klientów na identyfikatory. Po nawiązaniu połączenia przez Agenta z serwerem,
serwer nadaje mu unikane \textit{agentID} (liczbę całkowitą), które będzie służyło do korelacji oraz będzie
wykorzystywane przez GM w logice gry. Te samo \textit{agentID} wysyłane jest do Agenta w odpowiedzi na prośbę o dołączenie
oraz w wiadomości o rozpoczęciu rozgrywki.
wykorzystywane przez GM w logice gry.
\textit{agentID} może być unikalną losowa wartością lub kolejną wartością predefiniowanego ciągu
unikalnych wartości. To samo \textit{agentID}
wysyłane jest do Agenta w odpowiedzi na prośbę o dołączenie
oraz w wiadomości o rozpoczęciu rozgrywki. Ponowne połączenia po utracie komunikacji nie są możliwe.

\lstinputlisting[language=json]{./DefinicjeWiadomosci/messageWrapper.json}

\subsection{Wiadomości Agenta}
\subsubsection{Zapytanie czy trzymany fragment jest fikcyjny}
\textit{Payload} pusty
Expand Down
12 changes: 12 additions & 0 deletions Dokumentacja/MierzenieCzasu.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
\documentclass[Dokumentacja.tex]{subfiles}

\begin{document}
\section{Mierzenie czasów}
Czasy liczone są indywidualnie przez każdy moduł,
synchronizacja czasów nie jest prowadzona.
Czasy kar podane w konfiguracji są przez GM zaokrąglane do 10ms i taka powinna być dokładność
zegarów wszystkich modułów.
Agenty powinny same być w stanie obliczyć, kiedy mogą wykonać
kolejną akcję na podstawie długości kar i czasów wysłania/odebrania wiadomości.
GM na podstawie własnego zegara decyduje czy agent odczekał karę.
\end{document}
6 changes: 3 additions & 3 deletions Dokumentacja/Reguly.tex
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ \subsection{Kary czasowe}
\subsection{Poruszanie}
\begin{itemize}
\item Agent może poruszać się w 4 kierunkach: zachód, północ, wschód, południe, to jest; może przemieścić się na pole które jest przyległe do pola na którym się znajduje
\item Agent może przebywać na dowolnym polu planszy niezajętym przez innego Agenta
\item Agent może przebywać na dowolnym polu planszy niezajętym przez innego Agenta i nie należącym do pola bramkowego drużyny przeciwnej
\item Próba ruchu poza planszę skutkuje brakiem ruchu
\item Próba poruszenia się na pole zajęte przez innego agenta skutkuje brakiem ruchu
\item Próba poruszenia się dwóch różnych agentów na te samo pole skutkuje poruszeniem się jednego z nich, wybór agenta do poruszenia jest dowolny
Expand Down Expand Up @@ -79,8 +79,8 @@ \subsection{Akcja odkrycia}
\subsection{Wymiana informacji}
\begin{itemize}
\item W każdym momencie gry agent może zarządzać wymiany informacji z innym agentem
\item Odpowiedź na zapytanie agenta niebędącego liderem nie jest obligatoryjna
\item Odpowiedź na zapytanie agenta będącego liderem jest obligatoryjna i skutkuje zablokowaniem akcji pytanego agenta do udzielenia przez niego odpowiedzi
\item Odpowiedź na zapytanie agenta niebędącego liderem drużyny pytanego agenta nie jest obligatoryjna
\item Odpowiedź na zapytanie agenta będącego liderem drużyny pytanego agenta jest obligatoryjna i skutkuje zablokowaniem akcji pytanego agenta do udzielenia przez niego odpowiedzi
\item Odpowiedź na zapytanie może zostać udzielona w dowolnym czasie od zapytania o wymianę informacji, ale nie może zostać wysłana jeśli takie zapytanie nie miało wcześniej miejsca
\item Udzielane informacje nie muszą być prawdziwe
\end{itemize}
Expand Down
2 changes: 1 addition & 1 deletion UML/ClassDiagram/Player.puml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class Player {
+ havePiece: bool
+ board Field[,]
+ position: Tuple<int, int>
+ waitingPlayers: List<Tuple<int, bool>>
+ waitingPlayers: List<int>
- strategy: IStrategy
+ teamMates: int[]

Expand Down