PIMap {{K, T}, {K, T}, ...} constructor

doc ru

libs/main/io_devices/piiodevice.cpp

@@ -23,13 +23,7 @@
 #include "pipropertystorage.h"
 
 
-//! \addtogroup IO
-//! \{
 //! \class PIIODevice piiodevice.h
-//! \brief
-//! \~english Base class for input/output classes
-//! \~russian Базовый класс утройств ввода/вывода
-//!
 //! \~\details
 //! \section PIIODevice_sec0 Synopsis
 //! This class provide open/close logic, threaded read/write and virtual input/output
@@ -116,7 +110,6 @@
 //! \section PIIODevice_ex0 Example
 //! \snippet piiodevice.cpp 0
 //!
-//! \}
 
 
 PIMutex PIIODevice::nfp_mutex;
@@ -130,9 +123,6 @@ PIIODevice::PIIODevice(): PIThread() {
 }
 
 
-/*! \brief Constructs a PIIODevice with path and mode
- * \param path path to device
- * \param type mode for open */
 PIIODevice::PIIODevice(const PIString & path, PIIODevice::DeviceMode mode): PIThread() {
 	mode_ = mode;
 	_init();
@@ -159,6 +149,34 @@ bool PIIODevice::setOption(PIIODevice::DeviceOption o, bool yes) {
 }
 
 
+//! \~\details
+//! \~english
+//! Set external static function of threaded read that will be executed
+//! at every successful threaded read. Function should have format
+//! "bool func(void * data, uchar * readed, int size)"
+//! \~russian
+//! Устанавливает внешний статический метод, который будет вызван
+//! после каждого успешного потокового чтения. Метод должен быть
+//! в формате "bool func(void * data, uchar * readed, int size)"
+void PIIODevice::setThreadedReadSlot(ReadRetFunc func) {
+	ret_func_ = func;
+}
+
+
+//! \~\details
+//! \~english
+//! Default size is 4096 bytes. If your device can read at single read
+//! more than 4096 bytes you should use this function to adjust buffer size
+//! \~russian
+//! По умолчанию 4096 байт. Если устройство за одно чтение может читать
+//! более 4096 байт, необходимо использовать этот метод для установки
+//! нужного размера буфера
+void PIIODevice::setThreadedReadBufferSize(int new_size) {
+	threaded_read_buffer_size = new_size;
+	threadedReadBufferSizeChanged();
+}
+
+
 bool stopThread(PIThread * t, bool hard) {
 #ifdef MICRO_PIP
 	t->stop(true);
@@ -524,6 +542,13 @@ PIString PIIODevice::fullPathOptions() const {
 }
 
 
+//! \~\details
+//! \~english
+//! To function \a configureFromFullPath() "full_path" passed without \a fullPathPrefix() and "://".
+//! See \ref PIIODevice_sec7
+//! \~russian
+//! В метод \a configureFromFullPath() "full_path" передается без \a fullPathPrefix() и "://".
+//! См. \ref PIIODevice_sec7
 PIIODevice * PIIODevice::createFromFullPath(const PIString & full_path) {
 	PIString prefix = full_path.left(full_path.find(":"));
 	PIIODevice * nd = newDeviceByPrefix(prefix.dataAscii());