botframework-streaming package
Classes
| PayloadAssembler |
Assembles payloads for streaming library. |
| ContentStream |
A stream of fixed or infinite length containing content to be decoded. |
| CancelDisassembler |
Streaming cancel disassembler. |
| HttpContentStreamDisassembler |
Disassembler for Http content stream |
| PayloadDisassembler |
Base class streaming payload disassembling. |
| RequestDisassembler |
Streaming request disassembler. |
| ResponseDisassembler |
Streaming response disassembler. |
| HttpContent |
The HttpContent class that contains a SubscribableStream. |
| HttpContentStream |
An attachment contained within a StreamingRequest's stream collection, which itself contains any form of media item. |
| NamedPipeClient |
Streaming transport client implementation that uses named pipes for inter-process communication. |
| NamedPipeServer |
Streaming transport server implementation that uses named pipes for inter-process communication. |
| NamedPipeTransport |
Named pipes based transport sender and receiver abstraction |
| PayloadReceiver |
Payload receiver for streaming. |
| PayloadSender |
Streaming payload sender. |
| TransportDisconnectedEvent |
Event to be included when disconnection events are fired. |
| HeaderSerializer |
Streaming header serializer |
| PayloadAssemblerManager |
Orchestrates assembly of payloads. |
| RequestManager |
Orchestrates and manages pending streaming requests. |
| SendOperations |
Send operations for streaming payloads. |
| StreamManager |
Orchestrates and manages streams. |
| ProtocolAdapter |
Creates a protocol adapter for Streaming. |
| RequestHandler |
Implemented by classes used to process incoming streaming requests sent over an IStreamingTransport. |
| StreamingRequest |
The basic request type sent over Bot Framework Protocol 3 with Streaming Extensions transports, equivalent to HTTP request messages. |
| StreamingResponse |
The basic response type sent over Bot Framework Protocol 3 with Streaming Extensions transports, equivalent to HTTP response messages. |
| SubscribableStream |
An extension of |
| NodeWebSocketFactory |
Represents a NodeWebSocketFactory to create a WebSocket server. |
| NodeWebSocketFactoryBase |
Represents an abstract NodeWebSocketFactoryBase class to create a WebSocket. |
| NodeWebSocket |
An implementation of ISocket to use with a NodeWebSocketFactory to create a WebSocket server. |
| WebSocketClient |
Web socket based client to be used as streaming transport. |
| WebSocketServer |
Web socket based server to be used as streaming transport. |
| WebSocketTransport |
Web socket based transport. |
Interfaces
| IAssemblerParams |
Parameters for a streaming assembler. |
| IBrowserFileReader |
Partially represents a FileReader from the W3C FileAPI Working Draft. For more information, see https://w3c.github.io/FileAPI/#APIASynch. This interface supports the framework and is not intended to be called directly for your code. |
| IBrowserWebSocket |
Partially represents a WebSocket from the HTML Living Standard. For more information, see https://html.spec.whatwg.org/multipage/web-sockets.html. This interface supports the framework and is not intended to be called directly for your code. |
| IEventEmitter |
Represents a EventEmitter from the |
| IHeader |
Streaming payload header definition. |
| IHttpContentHeaders |
Streaming Http content header definition. |
| INodeBuffer |
Represents a Buffer from the |
| INodeIncomingMessage |
Represents a IncomingMessage from the |
| INodeServer |
Represents a Server from the |
| AddressInfo | |
| INodeSocket |
Represents a Socket from the |
| WritableStream | |
| IReceiveRequest |
Streaming receive request definition. |
| IReceiveResponse |
Streaming response from a receive request. |
| IRequestPayload |
Definition for a streaming request payload. |
| IResponsePayload |
Base class for all dialogs. |
| ISendPacket |
Streaming send packet definition. |
| ISocket | |
| IStreamDescription |
Definition of a stream description. |
| IStreamWrapper |
Stream with length. |
| IStreamingTransportClient |
Abstraction to define the characteristics of a streaming transport client. Example possible implementations include WebSocket transport client or NamedPipe transport client. |
| IStreamingTransportServer |
Abstraction to define the characteristics of a streaming transport server. Example possible implementations include WebSocket transport server or NamedPipe transport server. |
| ITransport |
Abstraction for a generic transport definition. |
| ITransportReceiver |
Definition of a streaming transport that can receive requests. |
| ITransportSender |
Definition of a streaming transport that can send requests. |
Type Aliases
| BufferEncoding | |
| ValidBuffer |
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. |
| TransportDisconnectedEventHandler | |
| ConnectionListener | |
Enums
| PayloadConstants |
Constants for streaming payloads. |
| PayloadTypes |
Typess of payloads supported in the streaming library. |
Functions
| create |
Create a Node 'net' server |
| get |
Get a function that creates a Node 'net' server instance |
| generate |
Generates an uuid v4 string. |
Function Details
createNodeServer(ConnectionListener)
Create a Node 'net' server
function createNodeServer(callback?: ConnectionListener): INodeServer
Parameters
- callback
- ConnectionListener
Optional connection listener
Returns
a Node 'net' server instance
getServerFactory()
Get a function that creates a Node 'net' server instance
function getServerFactory(): (callback?: ConnectionListener) => INodeServer
Returns
(callback?: ConnectionListener) => INodeServer
a server factory function
generateGuid()
Generates an uuid v4 string.
function generateGuid(): string
Returns
string
An uuidv4 string.