Содержит описание результата чтения данных из потока.
Полное описание, параметры и ограничения
РезультатЧтенияДанных (ReadDataResult)
РезультатЧтенияДанных (ReadDataResult)
Доступен, начиная с версии 8.3.9.
Свойства:
ИндексМаркера (MarkerIndex)
МаркерНайден (MarkerFound)
Размер (Size)
Методы:
НачатьПолучениеБуфераДвоичныхДанных (BeginGetBinaryDataBuffer)
НачатьПолучениеДвоичныхДанных (BeginGetBinaryData)
ОткрытьПотокДляЧтения (OpenStreamForRead)
ПолучитьБуферДвоичныхДанных (GetBinaryDataBuffer)
ПолучитьБуферДвоичныхДанныхАсинх (GetBinaryDataBufferAsync)
ПолучитьДвоичныеДанные (GetBinaryData)
ПолучитьДвоичныеДанныеАсинх (GetBinaryDataAsync)
Описание:
Содержит описание результата чтения данных из потока.
Доступность:
Тонкий клиент, веб-клиент, мобильный клиент, сервер, толстый клиент, внешнее соединение, мобильное приложение (клиент), мобильное приложение (сервер), мобильный автономный сервер.
Использование в версии:
Доступен, начиная с версии 8.3.9.
Методическая информация
Практические примеры
Собрать пакет с версией, количеством и UTF-8 названием
Пакет имеет согласованную структуру: 1 байт версии, 2 байта количества, 4 байта длины названия, затем UTF-8. Проверяем поля до чтения тела.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
Серверный контекст, только память. Это учебный протокол, не формат какого-либо реального API.
Название кодируется в UTF-8 без BOM; целые записываются в LittleEndian.
В конструктор записи и чтения передаётся уже созданный поток: его закрываем отдельно после закрытия обоих объектов.
Название = ПолучитьБуферДвоичныхДанныхИзСтроки("Книга", КодировкаТекста.UTF8, Ложь);
Поток = Новый ПотокВПамяти;
Попытка
Запись = Новый ЗаписьДанных(Поток, КодировкаТекста.UTF8, ПорядокБайтов.LittleEndian);
Попытка
Запись.ЗаписатьБайт(1);
Запись.ЗаписатьЦелое16(3);
Запись.ЗаписатьЦелое32(Название.Размер);
Запись.ЗаписатьБуферДвоичныхДанных(Название);
Исключение
Запись.Закрыть();
ВызватьИсключение;
КонецПопытки;
Запись.Закрыть();
Сообщить(Поток.Размер());
Поток.Перейти(0, ПозицияВПотоке.Начало);
Чтение = Новый ЧтениеДанных(Поток, КодировкаТекста.UTF8, ПорядокБайтов.LittleEndian);
Попытка
Версия = Чтение.ПрочитатьБайт();
Если Версия <> 1 Тогда
ВызватьИсключение "Неподдерживаемая версия пакета";
КонецЕсли;
Количество = Чтение.ПрочитатьЦелое16();
Длина = Чтение.ПрочитатьЦелое32();
Если Количество = Неопределено Или Длина = Неопределено Тогда
ВызватьИсключение "Заголовок пакета оборван";
КонецЕсли;
Если Длина < 0 Или Длина > 1024 Тогда
ВызватьИсключение "Недопустимая длина названия";
КонецЕсли;
Результат = Чтение.Прочитать(Длина);
Если Результат.Размер <> Длина Тогда
ВызватьИсключение "Название получено не полностью";
КонецЕсли;
БуферНазвания = Результат.ПолучитьБуферДвоичныхДанных();
Сообщить(ПолучитьСтрокуИзБуфераДвоичныхДанных(БуферНазвания, КодировкаТекста.UTF8));
Сообщить(Количество);
Сообщить(Результат.ПолучитьДвоичныеДанные().Размер());
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
Чтение.Закрыть();
Исключение
Поток.Закрыть();
ВызватьИсключение;
КонецПопытки;
Поток.Закрыть();Разбор по шагам
Записываем поля заголовка в фиксированном порядке и длину тела в байтах.
Закрыть объекта записи сбрасывает её буферы, не закрывая переданный извне поток.
Возвращаем позицию в начало и читаем поля в том же порядке и с тем же порядком байтов.
Ограничиваем длину, проверяем фактический размер прочитанного тела и лишь затем декодируем название.
Как проверить результат
Размер пакета 17 байтов: 1 + 2 + 4 + 10; результат Книга и количество 3.
Замените записанную версию 1 на 2: чтение должно завершиться текстом Неподдерживаемая версия пакета.
Укажите при записи длину 100 вместо фактических 10: должна сработать проверка неполного названия.
Ожидаемый результат
Пакет прочитан с проверкой версии, ограничением размера и контролем неполного тела.
На что обратить внимание
Для сетевого потока частичное чтение может быть нормальным: в реальном сетевом протоколе собирайте тело циклом до нужного размера или завершения потока.
Нельзя доверять длине из внешнего пакета без верхнего ограничения: иначе можно выделить чрезмерную память.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.
Асинхронно пропустить служебную часть и прочитать поле до границы
Разбираем HDR|Книга#TAIL: сначала пропуск байтов и границы, затем получение поля и хвоста с обработкой отсутствующего маркера.
Где и как запускать
Модуль пустой управляемой формы учебной внешней обработки; тонкий или толстый клиент Windows. Вставьте весь модуль. Это не серверный код.
Подготовка
Создайте учебную внешнюю обработку с пустой управляемой основной формой. Создайте команду УчебныйПример и кнопку этой команды.
В свойстве команды Действие выберите процедуру УчебныйПример. Вставьте полный приведённый модуль формы.
Откройте EPF в тонком или толстом клиенте Windows и нажмите кнопку. Не переносите Ждать и Асинх в серверный общий модуль.
Пример работает только со своими данными в памяти; записи в базу, файлы и сеть нет.
&НаКлиенте
Асинх Процедура УчебныйПример(Команда)
Данные = ПолучитьДвоичныеДанныеИзСтроки("HDR|Книга#TAIL", КодировкаТекста.UTF8, Ложь);
Чтение = Новый ЧтениеДанных(Данные, КодировкаТекста.UTF8);
Попытка
Пропущено = Ждать Чтение.ПропуститьАсинх(3);
Если Пропущено <> 3 Тогда
ВызватьИсключение "Учебный заголовок неполный";
КонецЕсли;
Граница = Ждать Чтение.ПропуститьДоАсинх("|", КодировкаТекста.UTF8);
Если Граница = -1 Тогда
ВызватьИсключение "Обязательная граница не найдена";
КонецЕсли;
Поле = Ждать Чтение.ПрочитатьДоАсинх("#", КодировкаТекста.UTF8);
Если Не Поле.МаркерНайден Тогда
ВызватьИсключение "Не найдена граница поля";
КонецЕсли;
Двоичные = Ждать Поле.ПолучитьДвоичныеДанныеАсинх();
Сообщить(Граница = 0);
Сообщить(ПолучитьСтрокуИзДвоичныхДанных(Двоичные, КодировкаТекста.UTF8) = "Книга");
Хвост = Ждать Чтение.ПрочитатьСимволыАсинх();
Сообщить(Хвост = "TAIL");
НетГраницы = Ждать Чтение.ПропуститьДоАсинх("|", КодировкаТекста.UTF8);
Сообщить(НетГраницы = -1);
Ждать Чтение.ЗакрытьАсинх();
Исключение
Чтение.Закрыть();
ВызватьИсключение;
КонецПопытки;
КонецПроцедурыРазбор по шагам
Ждать ПропуститьАсинх возвращает фактическое число байтов, а не признак успеха.
Обязательную границу | ищем только после проверки полного трёхбайтового заголовка.
Результат ПропуститьДоАсинх с одним найденным маркером равен 0. При отсутствии возвращается -1.
ПрочитатьДоАсинх даёт РезультатЧтенияДанных. Проверяем его МаркерНайден перед преобразованием текстового поля.
TAIL читается после #; повторный поиск | на конце подтверждает отсутствие маркера.
Как проверить результат
Получены Книга и TAIL; успешный индекс 0, неуспешный -1; четыре сообщения Истина.
Измените первый разделитель на /: пример прекращает разбор с понятной ошибкой, а не объявляет сообщение корректным.
Ожидаемый результат
Учебное сообщение разобрано асинхронно с явными проверками границ.
На что обратить внимание
Пропуск трёх байтов подходит именно для ASCII-заголовка HDR.
Ошибки обязательных границ нельзя скрывать и продолжать разбор как будто сообщение корректно.
Пример не осуществляет HTTP-запрос и не является спецификацией внешнего протокола.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.