NamedPipeSessionClient 类

命名管道服务器辅助客户端类

Definition

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

C#

public class NamedPipeSessionClient : NamedPipeSessionClientBase, 
	INamedPipeSessionClient, INamedPipeSession, IClient, IDependencyObject, IDisposableObject, 
	IDisposable, ILoggerObject, IResolverConfigObject, IConfigObject, IPluginObject, 
	IResolverObject, IClosableClient, IOnlineClient, INamedPipeStreamClient, ISessionClient, 
	IIdClient, IClientSender, ISender, IRequestInfoSender, IIdSender, 
	IIdRequestInfoSender, IReceiverClient<IReceiverResult>, INamedPipeListenableClient

VB

Public Class NamedPipeSessionClient
	Inherits NamedPipeSessionClientBase
	Implements INamedPipeSessionClient, INamedPipeSession, IClient, IDependencyObject, 
	IDisposableObject, IDisposable, ILoggerObject, IResolverConfigObject, IConfigObject, 
	IPluginObject, IResolverObject, IClosableClient, IOnlineClient, INamedPipeStreamClient, 
	ISessionClient, IIdClient, IClientSender, ISender, IRequestInfoSender, 
	IIdSender, IIdRequestInfoSender, IReceiverClient(Of IReceiverResult), INamedPipeListenableClient

F#

type NamedPipeSessionClient = 
    class
        inherit NamedPipeSessionClientBase
        interface INamedPipeSessionClient
        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 ISessionClient
        interface IIdClient
        interface IClientSender
        interface ISender
        interface IRequestInfoSender
        interface IIdSender
        interface IIdRequestInfoSender
        interface IReceiverClient<IReceiverResult>
        interface INamedPipeListenableClient
    end

Inheritance: Object DisposableObject DependencyObject ConfigObject ResolverConfigObject NamedPipeSessionClientBase NamedPipeSessionClient

构造函数

NamedPipeSessionClient

初始化 NamedPipeSessionClient 类的一个新实例

属性

Closed	断开连接
Closing	即将断开连接(仅主动断开时有效)。
Config	配置项 (继承自 NamedPipeSessionClientBase。)
DataHandlingAdapter
DisposedValue	标识该对象是否已被释放 (继承自 DisposableObject。)
Id	用于索引的Id (继承自 NamedPipeSessionClientBase。)
IsClient	表示是否为客户端终端。当为时，表示是客户端。否则为服务器通讯终端。 (继承自 NamedPipeSessionClientBase。)
LastReceivedTime	最后一次接收到数据的时间 (继承自 NamedPipeSessionClientBase。)
LastSentTime	最后一次发送数据的时间 (继承自 NamedPipeSessionClientBase。)
ListenOption	获取监听配置。注意：一般情况下不要随意修改该值。 (继承自 NamedPipeSessionClientBase。)
Logger	日志记录器 (继承自 ConfigObject。)
Online	判断是否在线 (继承自 NamedPipeSessionClientBase。)
PipeStream	用于通讯的管道流。 (继承自 NamedPipeSessionClientBase。)
PluginManager	插件管理器 (继承自 NamedPipeSessionClientBase。)
ProtectedDataHandlingAdapter	(继承自 NamedPipeSessionClientBase。)
Protocol	终端协议 (继承自 NamedPipeSessionClientBase。)
Resolver	获取解析器实例。 (继承自 NamedPipeSessionClientBase。)
Service	获取包含此辅助类的主服务器类。 (继承自 NamedPipeSessionClientBase。)

方法

Abort	(继承自 NamedPipeSessionClientBase。)
ClearReceiver	移除同步数据接收器
CloneTo	将当前对象的依赖项克隆到目标对象中 (继承自 DependencyObject。)
CloseAsync	关闭客户端。 (继承自 NamedPipeSessionClientBase。)
CreateReceiver	获取一个同步数据接收器
Dispose	释放资源。内部已经处理了SuppressFinalize(Object) (继承自 DisposableObject。)
Dispose(Boolean)	处置资源 (继承自 NamedPipeSessionClientBase。)
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。)
MemberwiseClone	Creates a shallow copy of the current Object. (继承自 Object。)
OnInitialized	当初始化完成时，执行在OnNamedPipeConnecting(ConnectingEventArgs)之前。 (继承自 NamedPipeSessionClientBase。)
OnNamedPipeClosed	客户端已断开连接。 (重写 NamedPipeSessionClientBaseOnNamedPipeClosed(ClosedEventArgs))
OnNamedPipeClosing	即将断开连接(仅主动断开时有效)。 (重写 NamedPipeSessionClientBaseOnNamedPipeClosing(ClosingEventArgs))
OnNamedPipeConnected	当客户端完整建立Tcp连接。 (重写 NamedPipeSessionClientBaseOnNamedPipeConnected(ConnectedEventArgs))
OnNamedPipeConnecting	客户端正在连接。 (重写 NamedPipeSessionClientBaseOnNamedPipeConnecting(ConnectingEventArgs))
OnNamedPipeReceived	处理已接收到的数据。根据不同的数据处理适配器，会传递不同的数据 (重写 NamedPipeSessionClientBaseOnNamedPipeReceived(ReceivedDataEventArgs))
OnNamedPipeReceiving	当收到原始数据 (继承自 NamedPipeSessionClientBase。)
OnNamedPipeSending	触发命名管道发送事件的异步方法。 (继承自 NamedPipeSessionClientBase。)
ProtectedClearReceiver	(继承自 NamedPipeSessionClientBase。)
ProtectedCreateReceiver	(继承自 NamedPipeSessionClientBase。)
ProtectedDefaultSendAsync	(继承自 NamedPipeSessionClientBase。)
ProtectedResetIdAsync	直接重置内部Id。 (继承自 NamedPipeSessionClientBase。)
ProtectedSendAsync(IListArraySegmentByte)	异步发送数据。如果数据处理适配器不存在或无法拼接发送，则将所有传输字节合并到一个连续的内存块中发送。如果数据处理适配器存在且支持拼接发送，则直接发送传输字节列表。 (继承自 NamedPipeSessionClientBase。)
ProtectedSendAsync(IRequestInfo)	异步安全发送请求信息。 (继承自 NamedPipeSessionClientBase。)
ProtectedSendAsync(ReadOnlyMemoryByte)	异步发送数据，通过适配器模式灵活处理数据发送。 (继承自 NamedPipeSessionClientBase。)
ProtectedTryGetClient	尝试通过Id获得对应的客户端 (继承自 NamedPipeSessionClientBase。)
RemoveValueTValue	移除属性值。 (继承自 DependencyObject。)
ResetIdAsync	重新设置Id (继承自 NamedPipeSessionClientBase。)
SendAsync(IListArraySegmentByte)	异步组合发送数据。该发送会经过适配器封装，具体封装内容由适配器决定。
SendAsync(IRequestInfo)	异步发送数据。该发送会经过适配器封装，具体封装内容由适配器决定。
SendAsync(ReadOnlyMemoryByte)	异步发送数据。该发送会经过适配器封装，具体封装内容由适配器决定。
SendAsync(String, ReadOnlyMemoryByte)	异步向对应Id的客户端发送数据
SendAsync(String, IRequestInfo)	异步发送指定标识符和请求信息的方法
SetAdapter	设置适配器 (继承自 NamedPipeSessionClientBase。)
SetValueTValue	设置依赖注入的值，如果值已经存在，将被覆盖。 (继承自 DependencyObject。)
ThrowIfConfigIsNull	如果Config为空，则抛出ArgumentNullException的异常。 (继承自 ConfigObject。)
ThrowIfDisposed	判断当前对象是否已经被释放。如果已经被释放，则抛出ObjectDisposedException异常。 (继承自 DisposableObject。)
ToString	Returns a string that represents the current object. (继承自 Object。)
TryGetValueTValue	尝试获取依赖注入的值，当没有注入时，会返回。 (继承自 DependencyObject。)
TryRemoveValueTValue	尝试重置属性值，如果没有这个值，则返回。 (继承自 DependencyObject。)

扩展方法

CreateWaitingClient	为 INamedPipeSessionClient 类型的客户端创建一个等待客户端实例。 (由 WaitingClientExtension 定义。)
GetJsonRpcActionClient	获取基于Tcp协议或者WebSocket协议的双工JsonRpc端 (由 JsonRpcClientExtension 定义。)
Map	(由 Mapper 定义。)
Map	(由 Mapper 定义。)
MapTTarget	(由 Mapper 定义。)
SafeDispose	安全性释放（不用判断对象是否为空）。不会抛出任何异常。内部会判断DisposedValue的值，如果为，则不会再执行Dispose。 (由 SystemExtension 定义。)
SafeDispose	安全性释放（不用判断对象是否为空）。不会抛出任何异常。 (由 SystemExtension 定义。)
ToJsonString	转换为Json (由 SerializeConvert 定义。)

参见

引用

TouchSocket.NamedPipe 命名空间