PxPvdTransport.h

Go to the documentation of this file.
00001 //
00002 // Redistribution and use in source and binary forms, with or without
00003 // modification, are permitted provided that the following conditions
00004 // are met:
00005 //  * Redistributions of source code must retain the above copyright
00006 //    notice, this list of conditions and the following disclaimer.
00007 //  * Redistributions in binary form must reproduce the above copyright
00008 //    notice, this list of conditions and the following disclaimer in the
00009 //    documentation and/or other materials provided with the distribution.
00010 //  * Neither the name of NVIDIA CORPORATION nor the names of its
00011 //    contributors may be used to endorse or promote products derived
00012 //    from this software without specific prior written permission.
00013 //
00014 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
00015 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00016 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00017 // PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00018 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00019 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00020 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00021 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
00022 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00023 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00024 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00025 //
00026 // Copyright (c) 2008-2018 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


Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com