|
AGX Dynamics 2.42.3.1
|
Class for sending serialized agxSDK::Simulation over to a client. More...
#include <RemoteDebugServer.h>
Inheritance diagram for agxNet::RemoteDebugServer:Public Member Functions | |
| RemoteDebugServer (uint16_t port) | |
| Constructor. | |
| bool | getEnableCompression () const |
| bool | getEnableFrameSynchronizaton () const |
| void | setEnableCompression (bool flag) |
| Enable/disable compression of transmitted data. | |
| void | setEnableFrameSyncronization (bool flag) |
| Specifies if server should wait for client to send ready to recieve before sending new package. | |
Public Member Functions inherited from agxNet::RemoteDebugBase | |
| RemoteDebugBase () | |
| Default constructor. | |
| DataBlockRef | getBlock () |
| size_t | getMaxQueueSize () const |
| size_t | getQueueSize () |
| bool | hasData () |
| virtual bool | isConnected () |
| void | pushBlock (DataBlock *data) |
| Push a block of data for access either by client (simulation) or to be transmitted over socket. | |
| void | run () |
| This method is invoked by start. | |
| void | setMaxQueueSize (size_t numElements) |
| void | shutdown () |
| Shutdown the communication threads, will cause this client to be non-usable any more. | |
Public Member Functions inherited from agx::BasicThread | |
| BasicThread () | |
| Default constructor. | |
| BasicThread (const BasicThread &other)=delete | |
| virtual | ~BasicThread ()=default |
| Destructor. | |
| void | cancel () |
| Threads should normally not need to be killed. | |
| void | detach () |
| Detaches the thread to the background. | |
| unsigned int | getThreadState () |
| Returns the current thread state. | |
| bool | join () |
| Joins the thread. | |
| bool | joinable () |
| True if thread is joinable. | |
| BasicThread & | operator= (const BasicThread &rhs)=delete |
| virtual void | run () |
| This method is invoked by start. | |
| bool | setThreadAffinity (agx::UInt64 cpumask) |
| Thread Affinity can be used to influence on which logical cores threads are scheduled and allowed to run. | |
| bool | start () |
| Launches the thread. | |
Public Member Functions inherited from agx::Referenced | |
| Referenced () | |
| Default constructor. | |
| Referenced (const Referenced &) | |
| template<typename T > | |
| T * | as () |
| Subclass casting. | |
| template<typename T > | |
| const T * | as () const |
| template<typename T > | |
| T * | asSafe () |
| Safe subclass casting, return nullptr if template type does not match. | |
| template<typename T > | |
| const T * | asSafe () const |
| int | getReferenceCount () const |
| template<typename T > | |
| bool | is () const |
| Subclass test. | |
| Referenced & | operator= (const Referenced &) |
| Assignment operator. Will increment the number of references to the referenced object. | |
| void | reference (void *ptr=nullptr) const |
| Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it. | |
| void | unreference (void *ptr=nullptr) const |
| Decrement the reference count by one, indicating that a pointer to this object is referencing it. | |
| void | unreference_nodelete () const |
| Decrement the reference count by one, indicating that a pointer to this object is referencing it. | |
Protected Member Functions | |
| virtual | ~RemoteDebugServer () |
| virtual bool | waitForConnection () |
| virtual void | waitForDataAndTransfer () |
Protected Member Functions inherited from agxNet::RemoteDebugBase | |
| virtual | ~RemoteDebugBase () |
| virtual void | dropConnection () |
| Drop the connection to the remote host and wait for a new one. | |
| virtual void | handleConnectionDrop () |
| bool | isShutdown () |
| size_t | receiveData (uint8_t *data, size_t numBytes) |
| Receive data from remote party. | |
| void | releaseData () |
| size_t | sendData (const uint8_t *data, size_t numBytes) |
| Transmit data to remote party. | |
| virtual bool | waitForConnection ()=0 |
| void | waitForData () |
| virtual void | waitForDataAndTransfer ()=0 |
Protected Member Functions inherited from agx::Referenced | |
| virtual | ~Referenced () |
| Destructor. | |
| void | allocateObserverVector () const |
| void | deleteUsingDeleteHandler () const |
Additional Inherited Members | |
Public Types inherited from agxNet::RemoteDebugBase | |
| typedef agx::ref_ptr< DataBlock > | DataBlockRef |
Public Types inherited from agx::BasicThread | |
| enum | ThreadState { THREAD_NEW = 0 , THREAD_RUNNING = 1 , THREAD_DETACHED = 2 , THREAD_DONE = 3 , THREAD_JOINED = 4 , THREAD_CANCELLED = 5 } |
| States for the thread. More... | |
Static Public Member Functions inherited from agx::BasicThread | |
| static std::thread::native_handle_type | getCurrentThreadHandle () |
| Return a native_handle for the current executing thread. | |
Static Public Member Functions inherited from agx::Referenced | |
| template<typename T > | |
| static bool | ValidateCast (const Referenced *object) |
Static Protected Member Functions inherited from agx::Referenced | |
| static DeleteHandler * | getDeleteHandler () |
| static void | setDeleteHandler (DeleteHandler *handler) |
| Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to. | |
Protected Attributes inherited from agxNet::RemoteDebugBase | |
| agx::Block | m_hasData |
| agx::Block | m_hasReader |
| bool | m_isShutdown |
| agx::Mutex | m_mutex |
| size_t | m_queueSize |
| TCPSocketRef | m_socket |
Protected Attributes inherited from agx::BasicThread | |
| std::thread | m_handle |
| std::atomic< unsigned int > | m_state |
Protected Attributes inherited from agx::Referenced | |
| Mutex | m_mutex |
| ObserverContainer | m_observers |
| AtomicValue | m_refCount |
Class for sending serialized agxSDK::Simulation over to a client.
Definition at line 25 of file RemoteDebugServer.h.
| agxNet::RemoteDebugServer::RemoteDebugServer | ( | uint16_t | port | ) |
Constructor.
| port | - The port where the server will listen for connections. |
|
protectedvirtual |
| bool agxNet::RemoteDebugServer::getEnableCompression | ( | ) | const |
| bool agxNet::RemoteDebugServer::getEnableFrameSynchronizaton | ( | ) | const |
| void agxNet::RemoteDebugServer::setEnableCompression | ( | bool | flag | ) |
Enable/disable compression of transmitted data.
| flag | - if true, data will be compressed |
| void agxNet::RemoteDebugServer::setEnableFrameSyncronization | ( | bool | flag | ) |
Specifies if server should wait for client to send ready to recieve before sending new package.
By default this is set to true. If set to false, server will constantly send new frames no matter if a client is waiting or not.
|
protectedvirtual |
Implements agxNet::RemoteDebugBase.
|
protectedvirtual |
Implements agxNet::RemoteDebugBase.