TM SDK Documentation 3.1.0
Дерево страниц
КодОписание
InterfaceVersion GetVersion()Функция получения текущей версии интерфейса
void VerifyCredentials(1: Credentials cred)
throws(1: InvalidCredentials ex);		Функция проверки параметров доступа к интерфейсу pushAPI SDK.
Позволяет проверить возможность передачи данных до их реальной передачи:
ventId BeginEvent (1: Event event, 2: Credentials cred)
throws(1: InvalidEventFormat ex1, 2: InvalidCredentials ex2, 3: LicenseError ex3, 4: EventNotFound ex4, 5: DataNotFound ex5);

Функция инициирует процесс передачи события перехвата на Traffic Monitor, используя pushAPI SDK, где:

  • event – заполненная структура содержащая все «метаданные», которые описывают событие перехвата. Атрибуты: отправителя, получателя, списка потоков данных, которые связаны с событием;
  • cred – структура, которая позволяет авторизовать процесс передачи события;
  • return – идентификатор события с сессии передачи данных (в одной и той же TCP-сессии можно передавать несколько событий)
StreamId BeginStream (1: EventId event_id, 2: ItemId event_data_id)
throws(1: EventNotFound ex1, 2: DataNotFound ex2);

Функция инициирует передачу потока данных, который связан с событием перехвата данных, где:

  • event_id – идентификатор события, с которым связан данный поток данных. Возвращается функцией BeginEvent;
  • event_data_id – идентификатор передаваемых данных. Этот идентификатор передаётся в составе «метаданных» события, в поле evt_data;
  • return – идентификатор загружаемого потока
void SendStreamData(1: EventId object_id, 2: StreamId stream_id, 3: binary chunk)
throws(1: EventNotFound ex1, 2: StreamNotFound ex2, 3: InvalidEventFormat ex3);

Функция передаёт буфер данных в составе потока данных, который связан с событием перехвата данных, где:

  • event_id – идентификатор события, с которым связан данный поток данных. Возвращается функцией BeginEvent;
  • stream_id – идентификатор потока данных, в составе которого передаётся буфер. Возвращается функцией BeginStream;
  • chunk – буфер данных. Пользователь SDK сам должен выбирать разумный размер буфера данных, чтобы обеспечить достаточную скорость загрузки событий, но не перегружать сетевую инфраструктуру
void EndStream(1: EventId event_id, 2: StreamId stream_id)
throws(1: EventNotFound ex1, 2: StreamNotFound ex2, 3: InvalidEventFormat ex3);

Функция фиксирует конец передачи потока данных, связанного с событием перехвата, где:

  • event_id – идентификатор события, с которым связан данный поток данных. Возвращается функцией BeginEvent;
  • stream_id – идентификатор потока данных, в составе которого передаётся буфер. Возвращается функцией BeginStream
string GetEventDatabaseId(1: EventId object_id)
throws(1: EventNotFound ex1);

Функция получения уникального идентификатора события перехвата в системе Traffic Monitor, где:

  • event_id – идентификатор события, полученный вызовом BeginEvent.

Это значение можно использовать для ссылки на загруженное событие. Функцию можно вызывать после удачного выполнения функции BeginEvent

void EndEvent(1: EventId event_id, 2: bool abort)
throws(1: EventNotFound ex1, 2: InvalidEventFormat ex2, 3: LicenseError ex3);

Функция фиксирует конец передачи события перехвата, где:

  • event_id – идентификатор события, передача которого завершается;
  • abort – флаг прекращения обработки события в Traffic Monitor. Если выставлен флаг, то событие не попадает в БД

  • Нет меток