initial

vnproglib/cpp/include/vn/port.h

@@ -0,0 +1,82 @@
+#ifndef _VN_XPLAT_PORT_H_
+#define _VN_XPLAT_PORT_H_
+
+#include <cstddef>
+
+#include "export.h"
+
+namespace vn {
+namespace xplat {
+
+/// \brief Interface for a simple port.
+class vn_proglib_DLLEXPORT IPort
+{
+
+	// Types //////////////////////////////////////////////////////////////////
+	
+public:
+
+	/// \brief Callback handler signature that can receive notification when
+	/// new data has been received on the port.
+	///
+	/// \param[in] userData Pointer to user data that was initially supplied
+	///     when the callback was registered with registerDataReceivedHandler.
+	typedef void(*DataReceivedHandler)(void* userData);
+
+	// Public Methods /////////////////////////////////////////////////////////
+
+public:
+
+	virtual ~IPort() = 0;
+
+	/// \brief Opens the simple port.
+	virtual void open() = 0;
+
+	/// \brief Closes the simple port.
+	virtual void close() = 0;
+
+	/// \brief Indicates if the simple port is open.
+	///
+	/// \return <c>true</c> if the serial port is open; otherwise <c>false</c>.
+	virtual bool isOpen() = 0;
+
+	/// \brief Writes out data to the simple port.
+	///
+	/// \param[in] data The data array to write out.
+	/// \param[in] length The length of the data array to write out.
+	virtual void write(const char data[], size_t length) = 0;
+
+	/// \brief Allows reading data from the simple port.
+	///
+	/// \param[out] dataBuffer The data buffer to write the read data bytes to.
+	/// \param[in] numOfBytesToRead The number of bytes to attempt reading from
+	///     the simple port.
+	/// \param[out] numOfBytesActuallyRead The number of bytes actually read
+	///     from the simple port.
+	virtual void read(char dataBuffer[], size_t numOfBytesToRead, size_t &numOfBytesActuallyRead) = 0;
+
+	/// \brief Registers a callback method for notification when new data is
+	///     received on the port.
+	///
+	/// \param[in] userData Pointer to user data, which will be provided to the
+	///     callback method.
+	/// \param[in] handler The callback method.
+	virtual void registerDataReceivedHandler(void* userData, DataReceivedHandler handler) = 0;
+
+	/// \brief Unregisters the registered callback method.
+	virtual void unregisterDataReceivedHandler() = 0;
+
+	#if PYTHON && !PL156_ORIGINAL && !PL156_FIX_ATTEMPT_1
+	
+	virtual void stopThread(){}
+	virtual bool threadStopped(){ return false; }
+	virtual void resumeThread(){}
+
+	#endif
+
+};
+
+}
+}
+
+#endif