Список функций

Создаёт сокет для последующего http запроса.

_TCPHttpOpen ($type,$link[,$protocol])

Параметры функции:

$type	Тип запроса (GET, POST, HEAD, ...)
$link	Адрес запроса
$protocol	Опционально. Протокол (HTTP/0.9, HTTP/1.0, HTTP/1.1). По умолчанию используется HTTP/1.1

Возвращаемые значения:
При успешном выполнении: Возвращает ID созданного сокета (используеться для отправки пакета и приёма данных). @error = 0 @extended = 0
При ошибке: Возвращает 0. Устанавливаются значения:
@error = -1 (Неверная ссылка) @extended = 0
@error = -2 (Не удалось преобразовать имя хоста в IP адрес) @extended = значение windows API WSAGetError
@error = -3 (Не удалось создать сокет) @extended = 0

Добавляет заголовок запроса.

_TCPHttpSetRequestHeader ($header,$value)

Параметры функции:

$header	Заголовок запроса (например "User-Agent")
$value	Значение заголовка запроса (например "Mozilla/5.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0)")

Возвращаемые значения:
При успешном выполнении: Возвращает 1, в значение @extended записывается количество переданных заголовков. @error = 0
При ошибке: Возвращает 0. Устанавливает значение @error = -1 (Заголовок, и/или его значение пусты) @extended = 0

Добавляет список заголовков запроса.

_TCPHttpSetRequestHeader ($headers)

Параметры функции:

$headers

Заголовки запроса в формате "заголовок: значение"&@CRLF

Возвращаемые значения:
При успешном выполнении: Возвращает 1. @error = 0 @extended = 0
При ошибке: Возвращает 0. Устанавливаются значения:
@error = -1 (Передаваемая строка пуста) @extended = 0
@error = -2 (Одна из строк не является заголовком) @extended = номер строки

Отправляет пакет.

_TCPHttpSend ($Socket,[$value])

Параметры функции:

$Socket	Сокет, созданный функцией _TCPHttpOpen
$value	Опционально. Передаваемые параметры (например "user=name&password=mypass")

Возвращаемые значения:
При успешном выполнении: Возвращает 1. @error = 0 @extended = количество переданных байт
При ошибке: Возвращает 0. Устанавливается значение @error = -1 (Не удалось отправить пакет) @extended = значение windows API WSAGetError

Получает и возвращает статус пакета.

_TCPHttpGetStatus ($Socket)

Параметры функции:

$Socket

Сокет, созданный функцией _TCPHttpOpen

Возвращаемые значения:
При успешном выполнении: Возвращает статус (например 200, 404, 302 и т.п.). @extended = Статусное сообщение. @error = 0
При ошибке: Возвращает 0. Устанавливается значение @error = -1 (невозможно получить пакет) @extended = 0

Примечание: Вызов этой функции обязателен при приёме пакета, даже если вам не важен статус ответа. Функцию стоит вызывать только один раз для каждого пакета, для повторного получения статуса этого же пакета пользуйтесь функцией _TCPHttpStatus.

Возвращает статус пакета.

_TCPHttpStatus ($Socket)

Параметры функции:

$Socket

Сокет, созданный функцией _TCPHttpOpen

Возвращаемые значения:
При успешном выполнении: Возвращает статус (например 200, 404, 302 и т.п.). @error = 0 @extended = 0
При ошибке: Возвращает 0. Устанавливается значение @error = -1 (Пакет ещё не получен) @extended = 0

Примечание: Служит для возвращения ранее полученного статуса. Не путать с функцией _TCPHttpGetStatus.

Получает и возвращает заголовки ответа.

_TCPHttpGetAllResponseHeaders ($Socket)

Параметры функции:

$Socket

Сокет, созданный функцией _TCPHttpOpen

Возвращаемые значения:
При успешном выполнении: Возвращает все заголовки ответа. @extended = Количество заголовков ответа. @error = 0
При ошибке: Возвращает 0. Устанавливается значение @error = -1 (невозможно получить пакет) @extended = 0

Примечание: Вызов этой функции обязателен при приёме пакета, даже если вам не важны заголовки ответа. Функцию стоит вызывать только один раз для каждого пакета, для повторного получения заголовков ответа этого же пакета пользуйтесь функцией _TCPHttpAllResponseHeaders. Для успешного выполнения необходимо, чтобы была ранее выполнена функця _TCPHttpGetStatus

Возвращает заголовки ответа.

_TCPHttpAllResponseHeaders ($Socket)

Параметры функции:

$Socket

Сокет, созданный функцией _TCPHttpOpen

Возвращаемые значения:
При успешном выполнении: Возвращает все заголовки ответа. @error = 0 @extended = 0
При ошибке: Возвращает 0. Устанавливается значение @error = -1 (Пакет ещё не получен) @extended = 0

Примечание: Служит для возвращения ранее полученных заголовков ответа. Не путать с функцией _TCPHttpGetAllResponseHeaders.

Возвращает cookie, полученные из заголовков ответа.

_TCPHttpResponseCookies ($Socket)

Параметры функции:

$Socket

Сокет, созданный функцией _TCPHttpOpen

Возвращаемые значения:
При успешном выполнении: Возвращает все cookie's в строке, вида "cookie1=value1; cookie2=value2; cookie3=value3". @extended = Количество полученых cookie @error = 0
При ошибке: Возвращает 0. Устанавливаются значения:
@error = -1 (Пакет ещё не получен) @extended = 0
@error = -2 (Не найдено ни одного cookie) @extended = номер строки

Примечание: Служит для возвращения cookie's из ранее полученных заголовков ответа. Для успешного выполнения необходимо, чтобы были ранее выполнены функции _TCPHttpGetStatus и _TCPHttpGetAllResponseHeaders.

Получает и возвращает тело ответа.

_TCPHttpGetResponseBody ($Socket[,$isBinary])

Параметры функции:

$Socket	Сокет, созданный функцией _TCPHttpOpen
$isBinary	Опционально. Режим получения данных в бинарном виде. 1(по умолчанию) - бинарные данные, 2 - строковые данные.

Возвращаемые значения:
При успешном выполнении: Возвращает тело ответа. @extended = количество байт ответа @error = 0
При ошибке: Возвращает 0. Устанавливается значение @error = -1 (Пакет ещё не получен) @extended = 0

Примечание: Служит для возвращения тела ответа. Для успешного выполнения необходимо, чтобы были ранее выполнены функции _TCPHttpGetStatus и _TCPHttpGetAllResponseHeaders.
Т.к. при приёме в строковом виде (функцией TCPRecv) игнорируются некоторые символы, в данной функции приём происходит в бинарном виде и только потом, в зависимости от выбора, конвертируются в строковый.

Получает тело ответа в фоновом режиме.

_TCPHttpGetResponseBodyBG ($Socket)

Параметры функции:

$Socket

Сокет, созданный функцией _TCPHttpOpen

Возвращаемые значения:
При успешном выполнении: Возвращает 1. @error = 0 @extended = 0
При ошибке: Устанавливается значение @error = -1 (невозможно получить пакет) @extended = 0

Примечание: Служит для возвращения тела ответа в фоновом режиме. Для успешного выполнения необходимо, чтобы были ранее выполнены функции _TCPHttpGetStatus и _TCPHttpGetAllResponseHeaders. Функция принимает первый(пробный) байт тела ответа и регистрирует на выполнение каждые 250мс. функцию _TCPHttpGetResponseBodyAdlib, которая в последствии в течении загрузки устанавливает значения глобальных величин:
$TCPHTTP_CURBYTES = сколько байт тела ответа загружено. (если тело ответа загружено полностью - значение устанавливается в "-1")
$TCPHTTP_BODY = само тело ответа.
$TCPHTTP_SOCKET = сокет.
Только одна загрузка может выполняться в фоновом режиме одновременно. При старте новой фоновой загрузки, не дожидаясь завершения текущей - текущая загрузка будет прервана.

_TCPHttpGetResponseBodyAdlib ()

Примечание: Функция регистрируется в AdlibRegister и постоянно обновляет значения $TCPHTTP_CURBYTES и $TCPHTTP_BODY, по завершению приёма данных функция сама делает AdlibUnRegister и устанавливает значение $TCPHTTP_CURBYTES = "-1".

Примечания: Перед началом использования функций данной библиотеки необходимо инициализировать TCP протокол функцией TCPStartup().
После использования соответственно завершить функцией TCPShutdown().
При прикреплении библиотеки объявляются следующие глобальные переменные:
$sCommand - для временного хранения тела запроса.
$TCPHTTP_CURBYTES - для хранения текущего количества принятых байт (при загрузке в фоновом режиме).
$TCPHTTP_BODY - для хранения тела ответа в процессе загрузки и после её (при загрузке в фоновом режиме).
$TCPHTTP_SOCKET - для временного хранения сокета (при загрузке в фоновом режиме).