import { IncomingRoute } from './IncomingRoute';

/**
 * Сообщение с кусочком бинарных данных.
 * Клиент перед тем как отправить сообщение серверу {@link client.WebSocketClientAdapter.prepareBinary | ищет в структуре сообщения все BLOB значения}.
 *
 * Затем он заменяет эти значения на null, и добавляет мета информацию к сообщению например вот сюда {@link CallMessage.meta | CallMessage.meta.messageObjectInfo}.
 * После этого для каждого BLOB-a создается {@link client.SendBinary}, данные пилятся на куски и каждый кусок по порядку отправляется в виде BinaryMessage.
 */
export interface BinaryMessage extends IncomingRoute {

  /**
   * Идентификатор конкретной транзакции, например вызов метода.
   * С помощью этого идентификатора данная цепочка попадет в нужный объект.
   */
  transactionId: string;

  /**
   * Кусочек значения.
   */
  chunk: Buffer | null;

  /**
   * Путь к конкретному полю, для которого предназначен этот кусочек.
   */
  path: string;
}