WebSocketServer Class

Reference

Definition

Namespace:: Microsoft.Bot.Streaming.Transport.WebSockets

Assembly:: Microsoft.Bot.Streaming.dll

Package:: Microsoft.Bot.Streaming v4.22.7

Source:: WebSocketServer.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A server for use with the Bot Framework Protocol V3 with Streaming Extensions and an underlying WebSocket transport.

public class WebSocketServer : IDisposable, Microsoft.Bot.Streaming.Transport.IStreamingTransportServer

type WebSocketServer = class
    interface IStreamingTransportServer
    interface IDisposable

Public Class WebSocketServer
Implements IDisposable, IStreamingTransportServer

Inheritance: Object
WebSocketServer

Implements: IStreamingTransportServer IDisposable

Constructors

WebSocketServer(WebSocket, RequestHandler)

Initializes a new instance of the WebSocketServer class. Throws ArgumentNullException on null arguments.

Properties

IsConnected

Gets a value indicating whether or not this server is currently connected.

Methods

Disconnect()	Disconnects the WebSocketServer.
Dispose()	Disposes the object and releases any related objects owned by the class.
Dispose(Boolean)	Disposes objected used by the class.
SendAsync(StreamingRequest, CancellationToken)	Task used to send data over this server connection. Throws InvalidOperationException if called when server is not connected. Throws ArgumentNullException if request is null.
StartAsync()	Used to establish the connection used by this server and begin listening for incoming messages.

Events

Disconnected

An event to be fired when the underlying transport is disconnected. Any application communicating with this server should subscribe to this event.

Applies to

Jaa