Документация Компонента предназначена для соединения с сервером Астериск через интерфейс AMI. Для соединения используются сокеты. Методом Соединить() устанавливается соединение с сервером. После чего можно отсылать сообщения при помощи ПослатьКоманду. Какие команды можно отсылать астериску читайте документацию здесь. Ответы с сервера можно читать с помощью метода ПолучитьКоманду или при помощи метода НачатьСлушать. Во втором случае ответы сервера нужно будет обрабатывать при помощи обработчика внешнего события. При прослушивании сервера можно продолжать отсылать команды серверу. Пример качайте здесь: В архиве содержится тестовый сервер ConsSrv.exe, Он принимает сообщения по порту 8887. При получении сообщения сервер выводит сообщение в консоль и отсылает полученное сообщение обратно клиенту. Так же в архиве находится демонстрационный MD файл и тестовая обработка. Они демонстрируют работу компоненты. Саму компоненту качайте отсюда
Описание методов и свойств.
ЗагрузитьКлюч (ПутьКФайлу) анг. LoadKey() Назначение: Загружает ключ (лицензию) из файла. Возвращает число 0 - если успешно, иначе возвращает код ошибки. Коды ошибок: 1-Файл лицензии не найден; 2-Ошибка формата файла. 3 – Ошибка чтения конфигурации компьютера. 4 – Загружен не верный ключ. Параметры: ПутьКФайлу – Строка. Путь к файлу лицензии; Замечание: Важно вызвать метод сразу после создания объекта. Если вызов был завершен с ошибкой. В окно сообщений 1С выводится текст вида: VVSAst : Чтобы получить лицензию отправьте этот ключ на e-mail <адрес почты>: <Ключ> Пример: Аст=СоздатьОбъект("Addin.VVSAst"); Аст.ЗагрузитьКлюч("C:\key.txt"); Метод появился, начиная с версии 1.2.1 (платная версия) Соединить(IP, PORT) анг. Connect() Назначение: Устанавливает соединение с сервером. Возвращает число 1 - если соединение установлено. 0 – если соединение не установлено. Параметры: IP – Строка. IP-адрес сервера; PORT – Число. Порт сервера. Отсоединить() анг. Disconnect () Назначение: Отсоединяется от сервера. ПослатьКоманду(Стр) анг. SendCommand() Назначение: Отсылает строку серверу Возвращает код ошибки. 0 – Без ошибок, Любое значение отличное от нуля – код ошибки. Параметры: Стр – Строка символов. Не забывайте добавлять к команде двойной перевод строки, как этот требует спецификация Астериск. Одной строкой Стр можно отсылать несколько команд, разделяя команды двойным переводом строки (РазделительСтрок+РазделительСтрок). ПолучитьКоманду(Сек,МилиСек,Стр) анг. GetCommand() Назначение: Получает строку символов с сервера. Строка возвращается в параметр Стр. Сама функция возвращает код ошибки. Параметры: Сек. – Число. Время ожидания в секундах. МилиСек – Число. Время ожидания в миллисекундах. Стр – Строка. В этот параметр возвращается полученная строка символов. Замечание: Время ожидания в Сек и МилиСек складывается. Если время ожидания ответа истекло ошибки не будет – в параметр Стр будет возвращена пустая строка. Полученная строка не превышает 255 символов. Если команда больше 255 символов, то Остальная часть команды будет получена при следующем вызове метода ПолучитьКомманду (или НачатьСлушать). НачатьСлушать(СтрРазделитель) анг. StartListen() Назначение: Переводит компоненту в режим прослушивания сообщений сервера. Сообщения будут приходить в обработку внешнего события. Параметры: СтрРазделитель – Строка. Разделитель команд. (Указывайте двойной разделитель строк (РазделительСтрок+РазделительСток), если работаете с астериском) Замечание: В обработку внешнего события будит приходить команды в таком формате: ОбработкаВнешнегоСобытия(Источник,Событие,Данные), где Источник = "addin.VVSAst” Событие = "event” (если нет ошибок) или "error” (Если произошла ошибка, например потеря соединения) Данные = <Строка данных, полученных с сервера>. Компонента прослушивает сервер в отдельном потоке и передает полученную информацию в 1С, вызывая обработчик ОбработкаВнешнегоСобытия.
ЗакончитьСлушать() анг. Stoplisten() Назначение: Останавливает прослушивание сервера. Замечание: С момента вызова ЗакончитьСлушать все приходящие с сервера считывается методом ПолучитьКоманду. Пока не вызвать ПолучитьКоманду сообщения будут накапливаться в буфере. Поэтому отключайтесь от сервера методом Отсоединить(), чтоб команды не накапливались. При вызове метода поток прослушивания сервера закрывается. Чтоб убедиться что поток закрыт используйте свойство РежимПрослушки.
ДобавитьФильтр(СтрФильтр) анг. AddFilter() Назначение: Только те сообщения, которые содержат подстроку строку СтрФильтр, будут передаваться в обработчик внешнего события 1С. Можно наложить несколько фильтров. тогда сообщение должно будет содержать все значения фильтров (по принципу «И»). Метод возвращает код ошибки. 0-Ошибок нет, другое значение - добавить фильтр не удалось. Параметры: СтрФильтр – Строка. При прослушивании будут приходить команды, содержащие указанную строку. Можно добавить не ограниченное количество фильтров. Замечание: Фильтр накладывается только на режим прослушивания. Рекомендуется накладывать необходимые фильтры до вызова НачатьСлушать. Метод появился в версии 1.1.0
ОчиститьФильтр() анг. ClearFilter() Назначение: Очищает значения всех фильтров. Замечание: Рекомендуется останавливать прослушивание методом ЗакончитьСлушать до очистки установленных фильтров. Метод появился в версии 1.1.0
ПолучитьСписокФильтров(Разделитель) анг. GetFilterList() Назначение: Возвращает строку, которая содержит все фильтры, разделенные указанным Разделителем. Параметры: Разделитель – Строка. Указывает какими символами разделить фильтры между собой. Замечание: ПолучитьСписокФильтров. Метод появился в версии 1.2.2
СоединениеУстановлено анг. Connected Назначение: Свойство только для чтения. 1 – Соединение установлено, 0 – Соединение не установлено. Замечание: При разрыве соединения свойство принимает значение 0. РежимПрослушки анг. Islisten Назначение: Свойство только для чтения. 1 – Компонента в режиме прослушивания сервера, 0 – Компонента НЕ в режиме прослушивания сервера. Замечание: После закрытия потока прослушивания, свойство принимает значение 0. Автор анг. Author Назначение: Свойство только для чтения. Строка. Возвращает строку, где указан автор компоненты Замечание: Свойство появилось, начиная с версии 1.1.0
Версия анг. Version Назначение: Свойство только для чтения. Строка. Замечание: Свойство появилось, начиная с версии 1.1.0
|