Class mgr client::Client

Материал из ISPWiki
Перейти к: навигация, поиск

Формирование запросов к панели

Класс mgr_client::Client

Данный класс является абстрактным

Интерфейс для классов Local и Remote.

#include <mgrclient.h> 

Описание:

class mgr_client::Client

Содержит набор функций общих как для локальных запросов, так и для запросов к удаленным панелям

See also: Local
See also: Remote

Потомки:


Открытые члены (кратко)

void Restart ()

Перезапустить панель


Client & Relocalize ( bool relocalize = true )

Локализовать сообщение об ошибке заново


Client & WaitLocked ( bool wait = true )

Не прерывать выполнение в случае блокировки панели

Выполнить запрос и получить результат

Методы Query формируют запрос к панели и возвращают результат. В случае, если результат содержит ошибку (тэг error), будет сформирован exception типа mgr_err::Error

Аргументы:
[query] запрос к панели в формате query string (имя1=значение1&имя2=значение2& ...)
[argX] данные строки будут закодированы функцией str::url::Encode и подставлены в запрос вместо символов '?'
[arg_map] к запросу будут добавлены параметры взятые из arg_map при этом имена и значения будут закодированы с использованием str::url::Encode
Returned: XML документ или exception, если xml документ содержит тэг error
See also: mgr_err::Error
See also: Result

void AddParams ( const string &data )

Задать дополнительные параметры

Приватные члены (кратко)

Методы

void AddParams ( const string &data )

Задать дополнительные параметры

Позволяет задать дополнительные параметры запроса, они будут добавлены к переданным в Query. Например, вы можете добавить authinfo или su ко всем запросам, выполняемым через данный экземпляр класса. Последовательный вызов AddParams будет добавлять новые параметры (они должны быть заданы в формате QUERY_STRING). AddParam добавляет один параметр, его имя и значение будут преобразованы при помощи str::url::Encode ClearParams сбрасывает все добавленные параметры.

void Restart ()

Перезапустить панель

Вызывает функцию exit. Вызов exit сам по себе не гарантирует, что последующие запросы будут выполнены уже после перезапуска. Данный метод будет ожидать, пока панель действительно не перезапустится

Client &Relocalize ( bool relocalize = true )

Локализовать сообщение об ошибке заново

Client &WaitLocked ( bool wait = true )

Не прерывать выполнение в случае блокировки панели

Не генерировать исключений в случае, если панель будет заблокирована. А так же предпринимать попытку повторного выполнения запроса, если он был прерван в связи с перезапуском панели