NamedPipeClient Class

Definition

Namespace:

Microsoft.Bot.Streaming.Transport.NamedPipes

Assembly:

Microsoft.Bot.Streaming.dll

Package:

Microsoft.Bot.Streaming v4.22.7

Source:

NamedPipeClient.cs

An implementation of IStreamingTransportClient for use with Named Pipes.

public class NamedPipeClient : IDisposable, Microsoft.Bot.Streaming.Transport.IStreamingTransportClient

type NamedPipeClient = class
    interface IStreamingTransportClient
    interface IDisposable

Public Class NamedPipeClient
Implements IDisposable, IStreamingTransportClient

Inheritance

Object

NamedPipeClient

Implements

IStreamingTransportClient IDisposable

Constructors

NamedPipeClient(String, RequestHandler, Boolean)

Initializes a new instance of the NamedPipeClient class. Throws ArgumentNullException if baseName is null, empty, or whitespace.

Properties

IncomingConnected	Gets a value indicating whether the NamedPipeClient has an incoming pipe connection.
IsConnected	Gets a value indicating whether or not this client is currently connected.
OutgoingConnected	Gets a value indicating whether the NamedPipeClient has an outgoing pipe connection.

Methods

ConnectAsync()	Establish a connection with no custom headers.
ConnectAsync(IDictionary<String,String>)	Establish a connection with optional custom headers.
Disconnect()	Method used to disconnect this client.
Dispose()	Disconnects the client 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 client connection. Throws InvalidOperationException if called when the client is disconnected. Throws ArgumentNullException if message is null.

Events

Disconnected

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