NamedPipeClient 类

命名管道客户端

Definition

命名空间： TouchSocket.NamedPipe
程序集： TouchSocket.NamedPipe (在 TouchSocket.NamedPipe.dll 中) 版本：3.0.0+ccaf96084d09f972257496d1dd63b8ba3c1e44f0

C#

public class NamedPipeClient : NamedPipeClientBase, 
	INamedPipeClient, INamedPipeSession, IClient, IDependencyObject, IDisposableObject, 
	IDisposable, ILoggerObject, IResolverConfigObject, IConfigObject, IPluginObject, 
	IResolverObject, IClosableClient, IOnlineClient, INamedPipeStreamClient, ISetupConfigObject, 
	IConnectableClient, IClientSender, ISender, IRequestInfoSender, IReceiverClient<IReceiverResult>

VB

Public Class NamedPipeClient
	Inherits NamedPipeClientBase
	Implements INamedPipeClient, INamedPipeSession, IClient, IDependencyObject, 
	IDisposableObject, IDisposable, ILoggerObject, IResolverConfigObject, IConfigObject, 
	IPluginObject, IResolverObject, IClosableClient, IOnlineClient, INamedPipeStreamClient, 
	ISetupConfigObject, IConnectableClient, IClientSender, ISender, IRequestInfoSender, 
	IReceiverClient(Of IReceiverResult)

F#

type NamedPipeClient = 
    class
        inherit NamedPipeClientBase
        interface INamedPipeClient
        interface INamedPipeSession
        interface IClient
        interface IDependencyObject
        interface IDisposableObject
        interface IDisposable
        interface ILoggerObject
        interface IResolverConfigObject
        interface IConfigObject
        interface IPluginObject
        interface IResolverObject
        interface IClosableClient
        interface IOnlineClient
        interface INamedPipeStreamClient
        interface ISetupConfigObject
        interface IConnectableClient
        interface IClientSender
        interface ISender
        interface IRequestInfoSender
        interface IReceiverClient<IReceiverResult>
    end

Inheritance: Object DisposableObject DependencyObject ConfigObject ResolverConfigObject SetupConfigObject NamedPipeClientBase NamedPipeClient

构造函数

NamedPipeClient

初始化 NamedPipeClient 类的一个新实例

属性

Closed	获取或设置管道客户端关闭时的事件处理程序。
Closing	获取或设置管道客户端即将关闭时的事件处理程序。
Config	配置项 (继承自 SetupConfigObject。)
Connected	成功连接到服务器
Connecting	准备连接的时候
DataHandlingAdapter
DisposedValue	标识该对象是否已被释放 (继承自 DisposableObject。)
IsClient	表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。 (继承自 NamedPipeClientBase。)
LastReceivedTime	最后一次接收到数据的时间 (继承自 NamedPipeClientBase。)
LastSentTime	最后一次发送数据的时间 (继承自 NamedPipeClientBase。)
Logger	日志记录器 (继承自 ConfigObject。)
Online	判断是否在线 (继承自 NamedPipeClientBase。)
PipeStream	用于通讯的管道流。 (继承自 NamedPipeClientBase。)
PluginManager	插件管理器 (继承自 SetupConfigObject。)
ProtectedDataHandlingAdapter	(继承自 NamedPipeClientBase。)
Protocol	终端协议 (继承自 NamedPipeClientBase。)
Received	接收到数据
Resolver	获取解析器实例。 (继承自 SetupConfigObject。)

方法

Abort	中断链接 (继承自 NamedPipeClientBase。)
ClearReceiver	移除同步数据接收器
CloneTo	将当前对象的依赖项克隆到目标对象中 (继承自 DependencyObject。)
CloseAsync	关闭客户端。 (继承自 NamedPipeClientBase。)
ConnectAsync	异步连接
CreateReceiver	获取一个同步数据接收器
Dispose	释放资源。内部已经处理了SuppressFinalize(Object) (继承自 DisposableObject。)
Dispose(Boolean)	处置资源 (继承自 NamedPipeClientBase。)
Equals	Determines whether the specified object is equal to the current object. (继承自 Object。)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (继承自 Object。)
GetHashCode	Serves as the default hash function. (继承自 Object。)
GetType	Gets the Type of the current instance. (继承自 Object。)
GetValueTValue	获取依赖注入的值，当没有注入时，会返回默认行为的值。 (继承自 DependencyObject。)
HasValueTValue	判断在当前对象中是否有已设置的属性值。 (继承自 DependencyObject。)
LoadConfig	加载配置 (继承自 SetupConfigObject。)
MemberwiseClone	Creates a shallow copy of the current Object. (继承自 Object。)
OnNamedPipeClosed	断开连接。在客户端未设置连接状态时，不会触发 (重写 NamedPipeClientBaseOnNamedPipeClosed(ClosedEventArgs))
OnNamedPipeClosing	即将断开连接(仅主动断开时有效)。 (重写 NamedPipeClientBaseOnNamedPipeClosing(ClosingEventArgs))
OnNamedPipeConnected	已经建立管道连接 (重写 NamedPipeClientBaseOnNamedPipeConnected(ConnectedEventArgs))
OnNamedPipeConnecting	准备连接的时候，此时已初始化Socket，但是并未建立Tcp连接 (重写 NamedPipeClientBaseOnNamedPipeConnecting(ConnectingEventArgs))
OnNamedPipeReceived	处理已接收到的数据。根据不同的数据处理适配器，会传递不同的数据 (重写 NamedPipeClientBaseOnNamedPipeReceived(ReceivedDataEventArgs))
OnNamedPipeReceiving	当收到原始数据 (继承自 NamedPipeClientBase。)
OnNamedPipeSending	触发命名管道发送事件的异步方法。 (继承自 NamedPipeClientBase。)
PipeConnectAsync	建立管道的连接。 (继承自 NamedPipeClientBase。)
ProtectedClearReceiver	(继承自 NamedPipeClientBase。)
ProtectedCreateReceiver	(继承自 NamedPipeClientBase。)
ProtectedDefaultSendAsync	(继承自 NamedPipeClientBase。)
ProtectedSendAsync(IListArraySegmentByte)	异步发送经过处理的数据。如果ProtectedDataHandlingAdapter未设置或者不支持拼接发送，则将transferBytes合并到一个连续的内存块中再发送。如果ProtectedDataHandlingAdapter已设置且支持拼接发送，则直接发送transferBytes。 (继承自 NamedPipeClientBase。)
ProtectedSendAsync(IRequestInfo)	异步安全发送请求信息。 (继承自 NamedPipeClientBase。)
ProtectedSendAsync(ReadOnlyMemoryByte)	异步发送数据，根据是否配置了数据处理适配器来决定数据的发送方式。 (继承自 NamedPipeClientBase。)
RemoveValueTValue	移除属性值。 (继承自 DependencyObject。)
SendAsync(IListArraySegmentByte)	异步组合发送数据。该发送会经过适配器封装，具体封装内容由适配器决定。
SendAsync(IRequestInfo)	异步发送数据。该发送会经过适配器封装，具体封装内容由适配器决定。
SendAsync(ReadOnlyMemoryByte)	异步发送数据。该发送会经过适配器封装，具体封装内容由适配器决定。
SetAdapter	设置适配器 (继承自 NamedPipeClientBase。)
SetupAsync	异步配置设置项 (继承自 SetupConfigObject。)
SetValueTValue	设置依赖注入的值，如果值已经存在，将被覆盖。 (继承自 DependencyObject。)
ThrowIfConfigIsNull	如果Config为空，则抛出ArgumentNullException的异常。 (继承自 ConfigObject。)
ThrowIfDisposed	判断当前对象是否已经被释放。如果已经被释放，则抛出ObjectDisposedException异常。 (继承自 DisposableObject。)
ToString	Returns a string that represents the current object. (继承自 Object。)
TryGetValueTValue	尝试获取依赖注入的值，当没有注入时，会返回。 (继承自 DependencyObject。)
TryRemoveValueTValue	尝试重置属性值，如果没有这个值，则返回。 (继承自 DependencyObject。)

扩展方法

Connect	同步执行连接操作。 (由 ClientExtension 定义。)
ConnectAsync	异步连接 (由 ClientExtension 定义。)
CreateWaitingClient	为 INamedPipeClient 类型的客户端创建一个等待客户端实例。 (由 WaitingClientExtension 定义。)
Map	(由 Mapper 定义。)
Map	(由 Mapper 定义。)
MapTTarget	(由 Mapper 定义。)
SafeDispose	安全性释放（不用判断对象是否为空）。不会抛出任何异常。内部会判断DisposedValue的值，如果为，则不会再执行Dispose。 (由 SystemExtension 定义。)
SafeDispose	安全性释放（不用判断对象是否为空）。不会抛出任何异常。 (由 SystemExtension 定义。)
Setup	同步配置方法。使用给定的配置对象进行设置。 (由 SetupConfigObjectExtension 定义。)
ToJsonString	转换为Json (由 SerializeConvert 定义。)
TryConnect	同步执行连接操作。不会抛出异常。 (由 ClientExtension 定义。)
TryConnectAsync	尝试连接。不会抛出异常。 (由 ClientExtension 定义。)

参见

引用

TouchSocket.NamedPipe 命名空间