physx::PxPvdTransport Class Reference

PxPvdTransport is an interface representing the data transport mechanism. This class defines all services associated with the transport: configuration, connection, reading, writing etc. It is owned by the application, and can be realized as a file or a socket (using one-line PxDefault<...> methods in PhysXExtensions) or in a custom implementation. This is a class that is intended for use by PVD, not by the application, the application entry points are PxPvd and PvdClient. More...

#include <PxPvdTransport.h>

Inheritance diagram for physx::PxPvdTransport:

Public Member Functions
virtual bool	connect ()=0
virtual void	disconnect ()=0
virtual bool	isConnected ()=0
virtual bool	write (const uint8_t *inBytes, uint32_t inLength)=0
virtual PxPvdTransport &	lock ()=0
virtual void	unlock ()=0
virtual void	flush ()=0
virtual uint64_t	getWrittenDataSize ()=0
virtual void	release ()=0

Detailed Description

PxPvdTransport is an interface representing the data transport mechanism. This class defines all services associated with the transport: configuration, connection, reading, writing etc. It is owned by the application, and can be realized as a file or a socket (using one-line PxDefault<...> methods in PhysXExtensions) or in a custom implementation. This is a class that is intended for use by PVD, not by the application, the application entry points are PxPvd and PvdClient.

Member Function Documentation

connect()

virtual bool physx::PxPvdTransport::connect ( )

pure virtual

Connects to the Visual Debugger application. return True if success

Implemented in physx::pvdsdk::NullFileTransport, physx::pvdsdk::PvdDefaultFileTransport, and physx::pvdsdk::PvdDefaultSocketTransport.

disconnect()

virtual void physx::PxPvdTransport::disconnect ( )

pure virtual

Disconnects from the Visual Debugger application. If we are still connected, this will kill the entire debugger connection.

Implemented in physx::pvdsdk::NullFileTransport, physx::pvdsdk::PvdDefaultFileTransport, and physx::pvdsdk::PvdDefaultSocketTransport.

flush()

virtual void physx::PxPvdTransport::flush ( )

pure virtual

send any data and block until we know it is at least on the wire.

Implemented in physx::pvdsdk::NullFileTransport, physx::pvdsdk::PvdDefaultFileTransport, and physx::pvdsdk::PvdDefaultSocketTransport.

getWrittenDataSize()

virtual uint64_t physx::PxPvdTransport::getWrittenDataSize ( )

pure virtual

Return size of written data.

Implemented in physx::pvdsdk::NullFileTransport, physx::pvdsdk::PvdDefaultFileTransport, and physx::pvdsdk::PvdDefaultSocketTransport.

isConnected()

virtual bool physx::PxPvdTransport::isConnected ( )

pure virtual

Return if connection to PVD is created.

Implemented in physx::pvdsdk::NullFileTransport, physx::pvdsdk::PvdDefaultFileTransport, and physx::pvdsdk::PvdDefaultSocketTransport.

write()

virtual bool physx::PxPvdTransport::write ( const uint8_t *  inBytes, uint32_t  inLength  )

pure virtual

write bytes to the other endpoint of the connection. should lock before witre. If an error occurs this connection will assume to be dead.

Implemented in physx::pvdsdk::NullFileTransport, physx::pvdsdk::PvdDefaultFileTransport, and physx::pvdsdk::PvdDefaultSocketTransport.

---

The documentation for this class was generated from the following file:

• RavEngine/deps/physx/physx/include/pvd/PxPvdTransport.h