Skip to content

Latest commit

 

History

History
295 lines (295 loc) · 20.6 KB

File metadata and controls

295 lines (295 loc) · 20.6 KB

Список методов в категории HTTP:

SetHTTPVerifyCertificate

Описание

Устанавливает, должно ли устройство проверять SSL-сертификат при создании защищенного соединения. Если сервер, к которому вы подключаетесь, использует самозаверяющий сертификат, вам нужно будет установить его равным 0, иначе соединение не удастся. Во всех остальных случаях вы должны оставить это значение равным 1, чтобы обеспечить безопасное соединение с сервером. Отключение проверки отключит защиту от атак man in the middle на SSL-соединения.

Определение

void agk::SetHTTPVerifyCertificate( UINT iHTTP, int mode )

Параметры

iHTTP - Идентификатор устанавливаемого соединения.
mode - 1 для проверки, 0 для не проверки.

Пример кода


SetHTTPTimeout

Описание

Устанавливает время в миллисекундах, в течение которого AGK будет ждать установления соединения, прежде чем отказаться от него.

Определение

void agk::SetHTTPTimeout( UINT iHTTP, int milliseconds )

Параметры

iHTTP - Идентификатор устанавливаемого соединения.
milliseconds - Время ожидания в миллисекундах.

Пример кода


SetHTTPHost

Описание

Задает домен хоста, к которому вы хотите подключиться, например для доступа www.thegamecreators.com/index.php вы бы использовали значение хоста www.thegamecreators.com, не включайте http:, который обычно идет перед ним. Обратите внимание, что попытка использовать определенный порт с www.thegamecreators.com:8080 на некоторых платформах это может быть проигнорировано, и в этих случаях будет использоваться порт 80. При экспорте в HTML5 обратите внимание, что веб-браузеры ограничивают количество серверов, к которым вы можете подключиться. По умолчанию вы ограничены файлами, размещенными на том же сервере, что и ваше приложение. Однако если сервер отправляет заголовок Access-Control-Allow-Origin в своем ответе, который разрешает сервер вашего приложения, то браузер позволит вам подключиться к нему.

Определение

UINT agk::SetHTTPHost( UINT iHTTP, const char *szHost, int iSecure )
UINT agk::SetHTTPHost( UINT iHTTP, const char *szHost, int iSecure, const char *szUser, const char *szPass )

Параметры

iHTTP - Идентификатор устанавливаемого соединения.
szHost - Домен для подключения.
iSecure - Установите значение 1, чтобы использовать защищенное соединение HTTPS, и 0, чтобы использовать стандартное соединение HTTP.
szUser - Имя пользователя для отправки на сервер.
szPass - Пароль для отправки на сервер.

Пример кода


SendHTTPRequestASync

Описание

Отправьте запрос на сервер, указанный в SetHTTPHost, например, если запрашивается http: www.thegamecreators.com/index.php szServerFile должен быть index.php. Эта команда немедленно возвращается и ждет ответа сервера в фоновом режиме. Вы можете проверить статус ответа с помощью GetHTTPResponseReady и, когда он будет готов, получить ответ с помощью GetHTTPResponse.

Определение

int agk::SendHTTPRequestASync( UINT iHTTP, const char *szServerFile )
int agk::SendHTTPRequestASync( UINT iHTTP, const char *szServerFile, const char *szPostData )

Параметры

iHTTP - Идентификатор используемого соединения.
szServerFile - Файл, который нужно запросить с сервера, включает в себя все, что находится после доменной части URL-адреса.
szPostData - Необработанные данные post для отправки на сервер обратите внимание, что & и = - это специальные символы, разделяющие переменные.

Пример кода


SendHTTPRequest

Описание

Отправьте запрос на сервер, указанный в SetHTTPHost (), например, если запрашивается http: www.thegamecreators.com/index.php szServerFile должен быть index.php. Эта команда ожидает ответа сервера и возвращает ответ сервера. Если вы используете уровень 2, вы должны удалить этот ответ, когда закончите с ним. Не работает при экспорте в HTML5

Определение

char* agk::SendHTTPRequest( UINT iHTTP, const char *szServerFile )
char* agk::SendHTTPRequest( UINT iHTTP, const char *szServerFile, const char *szPostData )

Параметры

iHTTP - Идентификатор используемого соединения.
szServerFile - Файл, который нужно запросить с сервера, включает в себя все, что находится после доменной части URL-адреса.
szPostData - Необработанные данные post для отправки на сервер обратите внимание, что & и = - это специальные символы, разделяющие переменные.

Пример кода


SendHTTPFile

Описание

Отправьте файл на сервер, указанный в SetHTTPHost, например, если запрашивается http: www.thegamecreators.com/index.php szServerFile должен быть index.php. Также позволяет отправлять POST-данные на сервер, которые могут включать переменные или файловые данные, например myvar=5&var2=test. Эта команда немедленно возвращается и ждет ответа сервера в фоновом режиме. Вы можете проверить статус ответа с помощью GetHTTPResponseReady и, когда он будет готов, получить ответ с помощью GetHTTPResponse. Вы можете проверить ход загрузки с помощью GetHTTPFileProgress. Не работает при экспорте в HTML5

Определение

int agk::SendHTTPFile( UINT iHTTP, const char *szServerFile, const char *szPostData, const char *szLocalFile )

Параметры

iHTTP - Идентификатор используемого соединения.
szServerFile - Файл, который нужно запросить с сервера, включает в себя все, что находится после доменной части URL-адреса.
szPostData - Необработанные данные post для отправки на сервер обратите внимание, что & и = - это специальные символы, разделяющие переменные.
szLocalFile - Имя файла, который вы хотите отправить на сервер.

Пример кода


RemoveHTTPHeader

Описание

Удаляет заголовок, который вы ранее добавили, если вы не использовали AddHTTPHeader для добавления заголовка с заданным именем, то эта команда ничего не делает. Если имя заголовка является стандартным заголовком, который обычно включается, то эта команда не удаляет его, а вместо этого использует AddHTTPHeader с пустой строкой, чтобы перезаписать его. Если имя заголовка является стандартным заголовком, который вы перезаписали, то эта команда возвращает его к нормальному значению. Обратите внимание, что эта команда не работает в версии HTML5.

Определение

void agk::RemoveHTTPHeader( UINT iHTTP, const char* headerName )

Параметры

iHTTP - Идентификатор соединения для изменения.
headerName - Имя заголовка для удаления

Пример кода


OpenBrowser

Описание

Открывает браузер по умолчанию текущей платформы и указывает его на заданную страницу.

Определение

void agk::OpenBrowser( const char *url )

Параметры

url - URL - адрес для открытия

Пример кода


HTTPEncode

Описание

Кодирует строку таким образом, чтобы она могла быть отправлена на сервер по протоколу HTTP без вмешательства в HTTP-запрос. Например, если вы хотите отправить переменную POST, содержащую символы & или=, они будут выглядеть как дополнительные переменные внутри строки, которую вы хотите отправить. Использование HTTPEncode в этой строке превратит эти символы в ПОСТ-безопасные значения, которые затем автоматически преобразуются обратно в исходные символы, как только они достигнут чего-то вроде PHP-скрипта. При этом используется стандартная кодировка URL-адреса для не буквенно-цифровых символов, оставляя только буквенно-цифровые символы.

Определение

char* agk::HTTPEncode( const char* str )

Параметры

str - Строка для кодирования

Пример кода


HTTPDecode

Описание

Декодирует строку, закодированную URL-адресом. Он может декодировать все буквенно-цифровые символы и большинство не буквенно-цифровых символов.

Определение

char* agk::HTTPDecode( const char* str )

Параметры

str - Строка для декодирования

Пример кода


GetInternetState

Описание

Возвращает 1, если устройство подключено к Интернету, и 0, если нет.

Определение

int agk::GetInternetState()

Параметры

Пример кода


GetHTTPStatusCode

Описание

Возвращает код состояния, который был возвращен с сервера в ответе. Вы должны дождаться, пока GetHTTPResponseReady вернет ненулевое значение, прежде чем проверять эту команду, иначе она вернет 0. Обычно код состояния равен 200, когда запрос был успешным

Определение

int agk::GetHTTPStatusCode( UINT iHTTP )

Параметры

iHTTP - Идентификатор соединения для проверки.

Пример кода


GetHTTPResponseReady

Описание

Возвращает 1, если запрос, ранее отправленный с помощью SendHTTPRequestASync, завершен. Вы можете получить ответ с помощью GetHTTPResponse. Возвращает 0, если запрос все еще выполняется, или -1, если запрос не удался.

Определение

int agk::GetHTTPResponseReady( UINT iHTTP )

Параметры

iHTTP - Идентификатор соединения для проверки.

Пример кода


GetHTTPFileComplete

Описание

Возвращает 1, если загрузка файла, ранее начатая с помощью GetHTTPFile, завершена, в противном случае-0. Даже если это возвращает 1, чтобы сказать, что загрузка завершена, возможно, она не удалась, проверьте GetHTTPResponseReady на наличие отрицательных значений, прежде чем предполагать, что загрузка прошла успешно.

Определение

int agk::GetHTTPFileComplete( UINT iHTTP )

Параметры

iHTTP - Идентификатор соединения для проверки.

Пример кода


GetHTTPFileProgress

Описание

Возвращает ход загрузки файла в виде плавающего значения от 0 до 100. Это не следует полагаться на то, чтобы работать, когда загрузка закончена, и на некоторых платформах может не дать точного представления о ходе загрузки. Используйте GetHTTPFileComplete или GetHTTPResponseReady, чтобы определить, завершена ли загрузка.

Определение

float agk::GetHTTPFileProgress( UINT iHTTP )

Параметры

iHTTP - Идентификатор соединения для проверки.

Пример кода


GetHTTPFile

Описание

Загружает HTTP - файл с сервера, указанного в SetHTTPHost, и сохраняет его в указанном месте. Также позволяет отправлять POST-данные на сервер, которые могут включать переменные или файловые данные, например myvar=5&var2=test. Эта команда немедленно возвращается и продолжает загрузку файла в фоновом режиме. Вы можете проверить ход загрузки с помощью GetHTTPFileProgress и GetHTTPFileComplete. Затем файл будет находиться в указанном вами месте, готовый к использованию с AGK.

Определение

int agk::GetHTTPFile( UINT iHTTP, const char *szServerFile, const char *szLocalFile, const char *szPostData )
int agk::GetHTTPFile( UINT iHTTP, const char *szServerFile, const char *szLocalFile )

Параметры

iHTTP - Идентификатор используемого соединения.
szServerFile - Файл, который нужно запросить с сервера, включает в себя все, что находится после доменной части URL-адреса.
szLocalFile - Место для сохранения в файл, это будет внутри папки записи для текущего устройства.
szPostData - Необработанные данные post для отправки на сервер обратите внимание, что & и = - это специальные символы, разделяющие переменные.

Пример кода


GetHTTPResponse

Описание

Возвращает ответ с сервера на предыдущий отправленный запрос SendHTTPRequestASync. Вы должны дождаться, пока GetHTTPResponseReady вернет 1, прежде чем вызывать эту команду. В tier 2 вы должны удалить возвращаемую строку с помощью agk::DeleteString, когда закончите ее использовать. Уровень 2 имеет дополнительную команду GetHTTPResponseReadyC, которая возвращает const char, который не нуждается в удалении.

Определение

char* agk::GetHTTPResponse( UINT iHTTP )

Параметры

iHTTP - Идентификатор соединения для проверки.

Пример кода


DeleteHTTPConnection

Описание

Удаляет ранее созданное HTTP-соединение.

Определение

void agk::DeleteHTTPConnection( UINT iHTTP )

Параметры

iHTTP - Идентификатор соединения для удаления.

Пример кода


CreateHTTPConnection

Описание

Создает HTTP - соединение, готовое к использованию позже. Возвращает идентификатор, используемый для ссылки на него позже.

Определение

UINT agk::CreateHTTPConnection()

Параметры

Пример кода


CloseHTTPConnection

Описание

Закрывает соединение с сервером, дальнейшие соединения могут быть созданы, если вы снова вызовете SetHTTPHost.

Определение

void agk::CloseHTTPConnection( UINT iHTTP )

Параметры

iHTTP - Идентификатор соединения для закрытия.

Пример кода


AddHTTPHeader

Описание

Добавляет указанный заголовок ко всем будущим запросам. Если заголовок уже существует, то его значение будет перезаписано новым значением. Если заголовок является стандартным заголовком, который обычно присутствует, то его значение будет перезаписано значением, которое вы даете. Если заголовок является стандартным заголовком, который обычно присутствует, а значение, которое вы даете, является пустой строкой, то стандартный заголовок будет удален. Не добавляйте двоеточие ни в одно из полей, оно будет добавлено автоматически между ними. Обратите внимание, что эта команда не работает в версии HTML5.

Определение

void agk::AddHTTPHeader( UINT iHTTP, const char* headerName, const char* headerValue )

Параметры

iHTTP - Идентификатор соединения для изменения.
headerName - Имя устанавливаемого заголовка, например Content-Type
headerValue - Новое значение для заголовка

Пример кода