PipeReadWriteExtensions.Read(TMessage) Method

Tungsten Suite

previous page next page

PipeReadWriteExtensionsReadTMessage Method

Waits for a message to be read from the pipe

Namespace:  W.IO.Pipes
Assembly:  Tungsten.IO.Pipes (in Tungsten.IO.Pipes.dll) Version: 2.0.3
Syntax
C#
Copy
public static TMessage Read<TMessage>(
	this Pipe<TMessage> pipe
)

Parameters

pipe
Type: W.IO.PipesPipeTMessage
The pipe from which to read data

Type Parameters

TMessage

[Missing <typeparam name="TMessage"/> documentation for "M:W.IO.Pipes.PipeReadWriteExtensions.Read``1(W.IO.Pipes.Pipe{``0})"]

Return Value

Type: TMessage
The message received or null if the read failed (the pipe was closed)

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type PipeTMessage. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
See Also
previous page start next page