1 | // |
2 | // Redistribution and use in source and binary forms, with or without |
3 | // modification, are permitted provided that the following conditions |
4 | // are met: |
5 | // * Redistributions of source code must retain the above copyright |
6 | // notice, this list of conditions and the following disclaimer. |
7 | // * Redistributions in binary form must reproduce the above copyright |
8 | // notice, this list of conditions and the following disclaimer in the |
9 | // documentation and/or other materials provided with the distribution. |
10 | // * Neither the name of NVIDIA CORPORATION nor the names of its |
11 | // contributors may be used to endorse or promote products derived |
12 | // from this software without specific prior written permission. |
13 | // |
14 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY |
15 | // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
16 | // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
17 | // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
18 | // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
19 | // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
20 | // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
21 | // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY |
22 | // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
24 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
25 | // |
26 | // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved. |
27 | // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved. |
28 | // Copyright (c) 2001-2004 NovodeX AG. All rights reserved. |
29 | |
30 | #ifndef PXPVDSDK_PXPVDTRANSPORT_H |
31 | #define PXPVDSDK_PXPVDTRANSPORT_H |
32 | |
33 | /** \addtogroup pvd |
34 | @{ |
35 | */ |
36 | #include "foundation/PxErrors.h" |
37 | #include "foundation/PxFlags.h" |
38 | #include "pvd/PxPvd.h" |
39 | |
40 | #if !PX_DOXYGEN |
41 | namespace physx |
42 | { |
43 | #endif |
44 | |
45 | /** |
46 | \brief PxPvdTransport is an interface representing the data transport mechanism. |
47 | This class defines all services associated with the transport: configuration, connection, reading, writing etc. |
48 | It is owned by the application, and can be realized as a file or a socket (using one-line PxDefault<...> methods in |
49 | PhysXExtensions) or in a custom implementation. This is a class that is intended for use by PVD, not by the |
50 | application, the application entry points are PxPvd and PvdClient. |
51 | */ |
52 | |
53 | class PxPvdTransport |
54 | { |
55 | public: |
56 | // connect, isConnected, disconnect, read, write, flush |
57 | |
58 | /** |
59 | Connects to the Visual Debugger application. |
60 | return True if success |
61 | */ |
62 | virtual bool connect() = 0; |
63 | |
64 | /** |
65 | Disconnects from the Visual Debugger application. |
66 | If we are still connected, this will kill the entire debugger connection. |
67 | */ |
68 | virtual void disconnect() = 0; |
69 | |
70 | /** |
71 | * Return if connection to PVD is created. |
72 | */ |
73 | virtual bool isConnected() = 0; |
74 | |
75 | /** |
76 | * write bytes to the other endpoint of the connection. should lock before witre. If an error occurs |
77 | * this connection will assume to be dead. |
78 | */ |
79 | virtual bool write(const uint8_t* inBytes, uint32_t inLength) = 0; |
80 | |
81 | /* |
82 | lock this transport and return it |
83 | */ |
84 | virtual PxPvdTransport& lock() = 0; |
85 | |
86 | /* |
87 | unlock this transport |
88 | */ |
89 | virtual void unlock() = 0; |
90 | |
91 | /** |
92 | * send any data and block until we know it is at least on the wire. |
93 | */ |
94 | virtual void flush() = 0; |
95 | |
96 | /** |
97 | * Return size of written data. |
98 | */ |
99 | virtual uint64_t getWrittenDataSize() = 0; |
100 | |
101 | virtual void release() = 0; |
102 | |
103 | protected: |
104 | virtual ~PxPvdTransport() |
105 | { |
106 | } |
107 | }; |
108 | |
109 | /** |
110 | \brief Create a default socket transport. |
111 | \param host host address of the pvd application. |
112 | \param port ip port used for pvd, should same as the port setting in pvd application. |
113 | \param timeoutInMilliseconds timeout when connect to pvd host. |
114 | */ |
115 | PX_C_EXPORT PxPvdTransport* PX_CALL_CONV |
116 | PxDefaultPvdSocketTransportCreate(const char* host, int port, unsigned int timeoutInMilliseconds); |
117 | |
118 | /** |
119 | \brief Create a default file transport. |
120 | \param name full path filename used save captured pvd data, or NULL for a fake/test file transport. |
121 | */ |
122 | PX_C_EXPORT PxPvdTransport* PX_CALL_CONV PxDefaultPvdFileTransportCreate(const char* name); |
123 | |
124 | #if !PX_DOXYGEN |
125 | } // namespace physx |
126 | #endif |
127 | |
128 | /** @} */ |
129 | #endif // PXPVDSDK_PXPVDTRANSPORT_H |
130 | |