Editing SimTX API/Session status (section)

== Life cycle ==
<syntaxhighlight lang="text">
 client                                                 server
   | -- [10] receiver_start / [12] transmitter_start --> |
   | <------------- [10] session_status  REJECTED ------- |   code + reason, then close
   |                         or                           |
   | <------------- [10] session_status  BOUND ---------- |   session_id, station, frequency
   |                    ... stream runs ...               |
   | <------------- [10] session_status  UPDATED -------- |   update_reason + current state
   | <------------- [10] session_status  UPDATED -------- |
   |                    ... stream runs ...               |
   | <------------- [10] session_status  ENDED ---------- |   code + reason, then close
</syntaxhighlight>

{| class="wikitable"
! State !! When !! Afterwards
|-
| <code>BOUND</code> || Once, when the start is accepted. || The stream begins: [[SimTX API/Packets/IqStreamDescriptor|IqStreamDescriptor]] for a receiver, [[SimTX API/Packets/TxQueue|TxQueue]] and [[SimTX API/Packets/TxAccept|TxAccept]] for a transmitter.
|-
| <code>REJECTED</code> || Instead of <code>BOUND</code>, when the start cannot be accepted. || The connection closes.
|-
| <code>UPDATED</code> || Any number of times, when something about the running session changed. || The session continues.
|-
| <code>ENDED</code> || When the server stops a running session. || The connection closes.
|}

<code>REJECTED</code> and <code>ENDED</code> are the only refusal and kick signal, for receivers and transmitters alike. They carry an [[SimTX API/Data types#ErrorCode|ErrorCode]] in <code>code</code> and a human-readable <code>reason</code>. Show the reason to the user; branch on the code.

A session can also end without a SessionStatus, when the connection itself fails or the account's lease runs out. Treat a closed connection as the end of the session.