Server API to enable remote debugging and visualization.
More...
#include <mochi_debug_server.h>
|
| virtual uint16_t | GetPort () const =0 |
| | Get the actual TCP port the server is listening on.
|
| virtual bool | HasConnection () const =0 |
| | Check whether a debugger client is currently connected.
|
| virtual bool | HasStarted () const =0 |
| | Check whether the server has started.
|
| virtual void | SetCoordinateSpace (CoordinateSpace const &space)=0 |
| | Declare the coordinate space this application's scene data is expressed in.
|
| virtual void | Start (uint16_t preferredPort=7333)=0 |
| | Start accepting client connections on a TCP port.
|
| virtual void | Stop ()=0 |
| | Stop the server and disconnect any connected client.
|
Server API to enable remote debugging and visualization.
- See also
- Context::GetDebugServer
Definition at line 25 of file mochi_debug_server.h.
◆ ~DebugServer()
| superdex::DebugServer::~DebugServer |
( |
| ) |
|
|
protecteddefault |
◆ GetPort()
| virtual uint16_t superdex::DebugServer::GetPort |
( |
| ) |
const |
|
pure virtual |
Get the actual TCP port the server is listening on.
May differ from the port requested in Start if that port was already in use.
- Returns
- The TCP port currently in use, or 0 if the server is not listening on a TCP socket.
- See also
- Start
◆ HasConnection()
| virtual bool superdex::DebugServer::HasConnection |
( |
| ) |
const |
|
pure virtual |
Check whether a debugger client is currently connected.
- Returns
- True if any debugger client is connected.
- See also
- Start, Stop
◆ HasStarted()
| virtual bool superdex::DebugServer::HasStarted |
( |
| ) |
const |
|
pure virtual |
Check whether the server has started.
- Returns
- True if Start has been called, even if the server is not actually able to accept connections due to issues with permissions or firewalls.
- See also
- Start, Stop
◆ SetCoordinateSpace()
| virtual void superdex::DebugServer::SetCoordinateSpace |
( |
CoordinateSpace const & | space | ) |
|
|
pure virtual |
Declare the coordinate space this application's scene data is expressed in.
Sent to the debugger client so it can render the scene in the correct orientation. This is purely descriptive metadata: it does not affect simulation. The default is X-right, Y-up, Z-backward.
- Parameters
-
| [in] | space | Coordinate space convention and unit scale of this application's scenes. |
- Note
- Must be called before Start.
- See also
- Start
◆ Start()
| virtual void superdex::DebugServer::Start |
( |
uint16_t | preferredPort = 7333 | ) |
|
|
pure virtual |
Start accepting client connections on a TCP port.
- Parameters
-
| [in] | preferredPort | Preferred TCP port to listen on. If the port is already in use, the next available port is chosen automatically. |
- Note
- No-op if the server has already been started.
- See also
- Stop, HasStarted, GetPort
◆ Stop()
| virtual void superdex::DebugServer::Stop |
( |
| ) |
|
|
pure virtual |
Stop the server and disconnect any connected client.
- Note
- No-op if the server has not started.
- See also
- Start, HasStarted
The documentation for this class was generated from the following files:
1.16.1