HttpClient

<< Click to Display Table of Contents >>

Navigation:  Проект в MasterSCADA 4D > Дерево библиотек > Библиотека Protocols > Protocols.ФБ >

HttpClient

Функциональный блок HttpClient предназначен для выполнения HTTP-запросов (версия HTTP 1.1/HTTPS) типа Get и Post. Функциональный блок находится в библиотеке Protocols.

Важно! Для возможности работы c  ФБ HttpClient в исполнительную систему должна входить опция MSRT4D-Int. Данная опция включена в базовый функционал лицензий Professional и Enterprise.

Вид в дереве

Вид в редакторе FBD

httpclient

httpclient_1

Входы и выходы ФБ:

Название

Тип

Назначение

Входы

Run

BOOL

Запускает выполнение запроса по переднему фронту. Если предыдущий запрос еще не выполнен, новый ставится в очередь

Timeout

TIME

Время ожидания запроса

URL

STRING

Указывается адрес сервера

RequestType

Protocols.HttpRequestType

Указывается тип запроса: Get или Post

ContentType

Protocols.HttpContentType

Определяет тип содержимого ресурса. Возможны варианты:

Form

JSON

XML

TextPlain

TextHTML

TextXML

Custom

Важно! Если выбран тип Custom, то пользователь должен задать всю необходимую информацию в заголовках.

Если задан тип Custom, то в AdditionalHeader пользователь имеет возможность задать любой ему необходимый заголовок ContentType с нужной кодировкой, c возможностью использования специфичных значений. Пример ContentType, который указывается в AdditionalHeader:

Content-type: Text/javascript; charset=utf-8

AdditionalHeader

STRING

Указывается заголовок HTTP-запроса. Нужно прописывать те заголовки, которые могут использоваться в запросах. Например, заголовок Connection определяет, в каком состоянии останется соединение после данного запроса.

Поддерживается передача нескольких заголовков. Это многострочный параметр. Формат ввода:

HeaderName1: Key=Value

HeaderName2: Key=Value

PostValue

STRING

Указывается параметр POST-запроса (в JSON-формате).

Выходы

Done

BOOL

Формируется результат выполнения запроса. После отработки запроса этот выход на один такт принимает значение TRUE.

RequestsCount

INT

Отображается число невыполненных запросов.

Error

BOOL

Сигнализирует о наличии ошибки при выполнении запроса. Если выход принимает значение 0, то это значит, что запрос выполнился без ошибок

ErrorMessage

STRING

Текст ошибки, возникшей при выполнении запроса. Если выход принимает значение no error, то это значит, что запрос выполнился без ошибок

HttpStatus

INT

Выдается HTTP-код выполнения запроса. Список кодов можно найти в открытом доступе в сети Internet.

ResultHeader

STRING

Выдается заголовок HTTP-ответа

Content

STRING

Выдается тело HTTP-ответа. Содержит информацию о ресурсе в формате, заданном на входе ContentType.

Специальные типы данных для данного ФБ находятся также в библиотеке Protocols.

httpclient_2

Типы данных отображаются только в полном дереве.

Смотрите также: