System.IO.Pipes.PipeStream Class Reference

Classes
class	ConnectionValueTaskSource
class	PipeValueTaskSource
class	ReadWriteValueTaskSource

Public Member Functions
unsafe override int	ReadByte ()
unsafe override void	WriteByte (byte value)
override void	Flush ()
override Task	FlushAsync (CancellationToken cancellationToken)
override void	SetLength (long value)
override long	Seek (long offset, SeekOrigin origin)
override int	Read (byte[] buffer, int offset, int count)
override int	Read (Span< byte > buffer)
override Task< int >	ReadAsync (byte[] buffer, int offset, int count, CancellationToken cancellationToken)
override ValueTask< int >	ReadAsync (Memory< byte > buffer, CancellationToken cancellationToken=default(CancellationToken))
override IAsyncResult	BeginRead (byte[] buffer, int offset, int count, AsyncCallback? callback, object? state)
override int	EndRead (IAsyncResult asyncResult)
override void	Write (byte[] buffer, int offset, int count)
override void	Write (ReadOnlySpan< byte > buffer)
override Task	WriteAsync (byte[] buffer, int offset, int count, CancellationToken cancellationToken)
override ValueTask	WriteAsync (ReadOnlyMemory< byte > buffer, CancellationToken cancellationToken=default(CancellationToken))
override IAsyncResult	BeginWrite (byte[] buffer, int offset, int count, AsyncCallback? callback, object? state)
override void	EndWrite (IAsyncResult asyncResult)
void	WaitForPipeDrain ()
void	CopyTo (Stream destination)
virtual void	CopyTo (Stream destination, int bufferSize)
Task	CopyToAsync (Stream destination)
Task	CopyToAsync (Stream destination, int bufferSize)
Task	CopyToAsync (Stream destination, CancellationToken cancellationToken)
virtual Task	CopyToAsync (Stream destination, int bufferSize, CancellationToken cancellationToken)
void	Dispose ()
virtual void	Close ()
virtual ValueTask	DisposeAsync ()
Task	FlushAsync ()
Task< int >	ReadAsync (byte[] buffer, int offset, int count)
Task	WriteAsync (byte[] buffer, int offset, int count)
object	GetLifetimeService ()
virtual object	InitializeLifetimeService ()

Static Public Member Functions
static Stream	Synchronized (Stream stream)

Static Public Attributes
static readonly Stream	Null = new NullStream()

Protected Member Functions
	PipeStream (PipeDirection direction, int bufferSize)
	PipeStream (PipeDirection direction, PipeTransmissionMode transmissionMode, int outBufferSize)
void	InitializeHandle (SafePipeHandle? handle, bool isExposed, bool isAsync)
override void	Dispose (bool disposing)
SemaphoreSlim	EnsureAsyncActiveSemaphoreInitialized ()
virtual WaitHandle	CreateWaitHandle ()
virtual void	ObjectInvariant ()
MarshalByRefObject	MemberwiseClone (bool cloneIdentity)

Static Protected Member Functions
static void	ValidateBufferArguments (byte[] buffer, int offset, int count)
static void	ValidateCopyToArguments (Stream destination, int bufferSize)

Protected Attributes
SemaphoreSlim	_asyncActiveSemaphore

Package Functions
void	UpdateMessageCompletion (bool completion)
virtual void	CheckPipePropertyOperations ()
void	CheckReadOperations ()
void	CheckWriteOperations ()
void	ValidateHandleIsPipe (SafePipeHandle safePipeHandle)
virtual void	TryToReuse (PipeValueTaskSource source)
Exception	WinIOError (int errorCode)
Task< int >	BeginReadInternal (byte[] buffer, int offset, int count, AsyncCallback callback, object state, bool serializeAsynchronously, bool apm)
Task	BeginWriteInternal (byte[] buffer, int offset, int count, AsyncCallback callback, object state, bool serializeAsynchronously, bool apm)

Static Package Functions
static string	GetPipePath (string serverName, string pipeName)
static unsafe global::Interop.Kernel32.SECURITY_ATTRIBUTES	GetSecAttrs (HandleInheritability inheritability)
static unsafe global::Interop.Kernel32.SECURITY_ATTRIBUTES	GetSecAttrs (HandleInheritability inheritability, PipeSecurity pipeSecurity, ref GCHandle pinningHandle)

Package Attributes
ThreadPoolBoundHandle	_threadPoolBinding

Properties
bool	IsConnected [get, protected set]
bool	IsAsync [get]
bool	IsMessageComplete [get]
SafePipeHandle	SafePipeHandle [get]
SafePipeHandle?	InternalHandle [get]
bool	IsHandleExposed [get]
override bool	CanRead [get]
override bool	CanWrite [get]
override bool	CanSeek [get]
override long	Length [get]
override long	Position [get, set]
PipeState	State [get, set]
bool	IsCurrentUserOnly [get, set]
virtual unsafe PipeTransmissionMode	TransmissionMode [get]
virtual unsafe int	InBufferSize [get]
virtual unsafe int	OutBufferSize [get]
virtual unsafe PipeTransmissionMode	ReadMode [get, set]
virtual bool	CanTimeout [get]
virtual int	ReadTimeout [get, set]
virtual int	WriteTimeout [get, set]

Private Member Functions
void	Init (PipeDirection direction, PipeTransmissionMode transmissionMode, uint outBufferSize)
void	InitializeAsyncHandle (SafePipeHandle handle)
void	DisposeCore (bool disposing)
unsafe int	ReadCore (Span< byte > buffer)
unsafe ValueTask< int >	ReadAsyncCore (Memory< byte > buffer, CancellationToken cancellationToken)
unsafe void	WriteCore (ReadOnlySpan< byte > buffer)
unsafe ValueTask	WriteAsyncCore (ReadOnlyMemory< byte > buffer, CancellationToken cancellationToken)
unsafe void	UpdateReadMode ()
bool	HasOverriddenBeginEndRead ()
bool	HasOverriddenBeginEndWrite ()
int	GetCopyBufferSize ()
Task< int >	BeginEndReadAsync (byte[] buffer, int offset, int count)
void	FinishTrackingAsyncOperation (ReadWriteTask task)
Task	BeginEndWriteAsync (byte[] buffer, int offset, int count)

Static Private Member Functions
static void	RunReadWriteTaskWhenReady (Task asyncWaiter, ReadWriteTask readWriteTask)
static void	RunReadWriteTask (ReadWriteTask readWriteTask)
static async Task	FinishWriteAsync (Task writeTask, byte[] localBuffer)

Private Attributes
SafePipeHandle	_handle
bool	_canRead
bool	_canWrite
bool	_isAsync
bool	_isCurrentUserOnly
bool	_isMessageComplete
bool	_isFromExistingHandle
bool	_isHandleExposed
PipeTransmissionMode	_readMode
PipeTransmissionMode	_transmissionMode
PipeDirection	_pipeDirection
uint	_outBufferSize
PipeState	_state
ReadWriteValueTaskSource	_reusableReadValueTaskSource
ReadWriteValueTaskSource	_reusableWriteValueTaskSource

Detailed Description

Definition at line 13 of file PipeStream.cs.

---

The documentation for this class was generated from the following file:

• source/System.IO.Pipes/System.IO.Pipes/PipeStream.cs