ayham
/
PaperTrader
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: add switchState

This commit is contained in:
altffour 2020-05-26 14:39:53 +03:00 committed by realaltffour
parent c19f7acbe9
commit 9dac064ad9
No known key found for this signature in database
GPG Key ID: C1265D839D44DCB1
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/protocol.pdf
View File

Binary file not shown.

15
docs/protocol.tex
View File

@ -652,6 +652,8 @@ that can be returned by a server due to a previous instruction:
\item purchaseFail
\item sellSuccess
\item sellFail
\item stateSwitchSuccess
\item stateSwitchFail
\item data
\end{itemize}
@ -701,12 +703,21 @@ failure, the server would return `purchaseFail' instruction with the reason
in the command's arguments.
\subsubsection{sellAsset(sessionID, name, quantity)}
The `sellAsset' instruction is from the set of command state instructionis, and
The `sellAsset' instruction is from the set of command state instructions, and
requires an active sesion ID to be provided from and to the worker server. The
sessoinID argument will identify the caller of the functioni. The second
sessoinID argument will identify the caller of the function. The second
argument is the name of the asset to sell. The third argument is the quantity
to buy. On success,the server would return `sellSuccess' instruction. On
failure, the server would return `sellFail' instruction with the reason in
the command's arguments.
\subsubsection{switchState(sessionID, state)}
The `switchState' instruction is from the set of command state instructions,
and requires an active session ID to be provided from and to the worker server.
The sessionID argument will identify the caller of the function. The second
argument is the state to switch to. The values of the states do not matter and
should be agreed on per implementation. On success, the server would return
`switchStateSuccess'. On failure, the server would return `switchstateFail'
with the reason in the command's arguments.
\end{document}