NamedPipeTransport class

Пакет:

botframework-streaming

Абстракция отправителей транспорта и получателей на основе именованных каналов

Конструкторы

NamedPipeTransport(INodeSocket)

Создает новый экземпляр класса NamedPipeTransport.

Свойства

isConnected	Возвращает true, если в данный момент подключено.
PipePath
ServerIncomingPath
ServerOutgoingPath

Методы

close()	Закрывает транспорт.
receive(number)	Получение от транспорта в буфер.
send(INodeBuffer)	Записывает в канал и отправляет.

Сведения о конструкторе

NamedPipeTransport(INodeSocket)

Создает новый экземпляр класса NamedPipeTransport.

new NamedPipeTransport(socket: INodeSocket)

Параметры

socket

INodeSocket

Объект сокета для сборки этого подключения.

Сведения о свойстве

isConnected

Возвращает true, если в данный момент подключено.

boolean isConnected

Значение свойства

boolean

true, если транспорт подключен и готов к отправке данных, false в противном случае.

PipePath

static PipePath: string

Значение свойства

string

ServerIncomingPath

static ServerIncomingPath: string

Значение свойства

string

ServerOutgoingPath

static ServerOutgoingPath: string

Значение свойства

string

Сведения о методе

close()

Закрывает транспорт.

function close()

receive(number)

Получение от транспорта в буфер.

function receive(count: number): Promise<INodeBuffer>

Параметры

count

number

Максимальный объем байтов для записи в буфер.

Возвращаемое значение

Promise<INodeBuffer>

Буфер, содержащий данные из транспорта.

send(INodeBuffer)

Записывает в канал и отправляет.

function send(buffer: INodeBuffer): number

Параметры

buffer

INodeBuffer

Буфер, полный данных для отправки по сокету.

Возвращаемое значение

number

Число, указывающее длину отправленных данных, если данные были успешно отправлены, в противном случае — значение 0.