NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPvdTransport.h Source File

00001 // This code contains NVIDIA Confidential Information and is disclosed to you
+00002 // under a form of NVIDIA software license agreement provided separately to you.
+00003 //
+00004 // Notice
+00005 // NVIDIA Corporation and its licensors retain all intellectual property and
+00006 // proprietary rights in and to this software and related documentation and
+00007 // any modifications thereto. Any use, reproduction, disclosure, or
+00008 // distribution of this software and related documentation without an express
+00009 // license agreement from NVIDIA Corporation is strictly prohibited.
+00010 //
+00011 // ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
+00012 // NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
+00013 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
+00014 // MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
+00015 //
+00016 // Information and code furnished is believed to be accurate and reliable.
+00017 // However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
+00018 // information or for any infringement of patents or other rights of third parties that may
+00019 // result from its use. No license is granted by implication or otherwise under any patent
+00020 // or patent rights of NVIDIA Corporation. Details are subject to change without notice.
+00021 // This code supersedes and replaces all information previously supplied.
+00022 // NVIDIA Corporation products are not authorized for use as critical
+00023 // components in life support devices or systems without express written approval of
+00024 // NVIDIA Corporation.
+00025 //
+00026 // Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved.
+00027 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
+00028 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
+00029 
+00030 #ifndef PXPVDSDK_PXPVDTRANSPORT_H
+00031 #define PXPVDSDK_PXPVDTRANSPORT_H
+00032 
+00036 #include "foundation/PxErrors.h"
+00037 #include "foundation/PxFlags.h"
+00038 #include "pvd/PxPvd.h"
+00039 
+00040 #if !PX_DOXYGEN
+00041 namespace physx
+00042 {
+00043 #endif
+00044 
+00053 class PxPvdTransport
+00054 {
+00055   public:
+00056     // connect, isConnected, disconnect, read, write, flush
+00057 
+00062     virtual bool connect() = 0;
+00063 
+00068     virtual void disconnect() = 0;
+00069 
+00073     virtual bool isConnected() = 0;
+00074 
+00079     virtual bool write(const uint8_t* inBytes, uint32_t inLength) = 0;
+00080 
+00081     /*
+00082         lock this transport and return it
+00083     */
+00084     virtual PxPvdTransport& lock() = 0;
+00085 
+00086     /*
+00087         unlock this transport
+00088     */
+00089     virtual void unlock() = 0;
+00090 
+00094     virtual void flush() = 0;
+00095 
+00099     virtual uint64_t getWrittenDataSize() = 0;
+00100 
+00101     virtual void release() = 0;
+00102 
+00103   protected:
+00104     virtual ~PxPvdTransport()
+00105     {
+00106     }
+00107 };
+00108 
+00115 PX_PVDSDK_API PxPvdTransport* PX_CALL_CONV
+00116 PxDefaultPvdSocketTransportCreate(const char* host, int port, unsigned int timeoutInMilliseconds);
+00117 
+00122 PX_PVDSDK_API PxPvdTransport* PX_CALL_CONV PxDefaultPvdFileTransportCreate(const char* name);
+00123 
+00124 #if !PX_DOXYGEN
+00125 } // namespace physx
+00126 #endif
+00127 
+00129 #endif // PXPVDSDK_PXPVDTRANSPORT_H
+