Навигация:  Traffic Inspector SDK > Встроенные скрипты >

Sender

Previous pageReturn to chapter overviewNext page

 

Через объект Sender доступны свойства объекта, запустившего задачу.

 

Задачи по событиям немедленно не выполняются, а ставятся в очередь. Для того, что-бы скрипт имел доступ к данным объекта, актуальным на момент события, в объекте Sender сохраняются все XML данные объекта - конфигурация и состояние. Набор XML данных соответствует conf_AttrLevelDetail (см. функцию API GetList).

 

function HasData()

 

Возвращает true, если есть XML данные объекта.

 

property XMLRoot (read only)

 

Возвращает корневой XML элемент данных объекта (тип IXMLDOMElement).

 

function GetAttribute(AttrName)

 

Возвращает атрибут корневого XML элемента. Тоже самое, что и XMLRoot.getElement()

 

function GetXMLValue(XPathRequest)

 

Тоже самое, что и XMLRoot.selectSingleNode(XPathRequest)

 

property GUID (read only)

property DisplayName (read only)

 

Свойства GUID и DisplayName объекта.

 

property ListType (read only)

 

Тип списка APIListType, к которому относится объект

 

property OldState (read only)

property NewState (read only)

 

Для скрипта, запущенного по изменению состояния объекта, OldState и NewState это старые и новые переменные состояния. Если скрипт был запущен по другому поводу (загрузка конфигурации, ручной запуск и т.д.), то оба параметра равны.

 

Для клиента или группового счета состояние вычисляется на основе двух параметров - состояние баланса и причина блокировки. Значения состояния баланса -

Авторизован = 1

Кредитный режим = 2

Блокирован = состояние блокировки UserBlockReason со знаком минус.

 

Для внешнего контролируемого счетчика имеются состояния -

 

Норма = 0

Предупреждение = 1

Лимит исчерпан = 2

Ежедневный лимит исчерпан = 3

 

function StateAsString(State)

 

Возвращает текстовое описание переменной состояния.

 

property EventType (read only)

 

Можно получить признак, какой скрипт объекта был использован - ScriptType_StateChange или ScriptType_LimitChange

 

property ConfigLoading (read only)

 

true, если скрипт был запущен по загрузке конфигурации объекта.

 

property NewXMLRoot (read only)

 

Создает новый XML документ конфигурации объекта для модификации данных с корневым элементом соответствующего имени и обязательным атрибутом GUID.

 

procedure SetAttribute(AttrName, Value)

 

Добавляет атрибут в корневой элемент нового XML документа. Если ранее новый документ не был создан, то он создается (см. NewXMLRoot).

 

procedure ApplyNewXML()

 

Применяет новые настройки объекта, используя новый XML документ (см NewXMLRoot и SetAttribute). Если новый документ создан не был, то вызов игнорируется.

 

function CreateSNMPAccessServerObject(WriteAccess)

 

Функция создает объект управления SNMP с интерфейсом ISNMP для устройства доступа, прописанного в настройках авторизации клиента. Если настроек нет, то возвращается null. WriteAccess - false, если требуется использовать Community из настроек устройства только для операций чтения, иначе true.

 

property AccessServerPort

 

Возвращает номер порта устройства доступа, прописанного в настройках авторизации клиента.

 

function AdvAttrVerify(const AGUID: WideString; const DisplayName: WideString;

                      DataType: AdvAttrDataType; VisInList: WordBool; VisInMonitor: WordBool;

                      NotEdit: WordBool; NotEditDesc: WordBool): WordBool;

property AdvAttrData[const Attr: WideString]: OleVariant;

 

Упрощенные варианты функции AdvAttrVerify и свойства AdvAttrData от API администрирования в контексте данного объекта.

 


Текущая страница справки: http://help.smart-soft.ru/doc20/index.html?sdk_sender.htm

Сайт разработчиков Traffic Inspector