PipeClient(TMessage) Class

Tungsten Suite

PipeClientTMessage Class

The generic version of PipeClient. This class expects all messages to be of the specified type.
Inheritance Hierarchy
SystemObject  W.IO.PipesPipe
    W.IO.PipesPipeTMessage
      W.IO.PipesPipeClientTMessage
        W.IO.PipesPipeClient

Namespace:  W.IO.Pipes
Assembly:  Tungsten.IO.Pipes (in Tungsten.IO.Pipes.dll) Version: 2.0.3
Syntax
C#
public class PipeClient<TMessage> : Pipe<TMessage>

Type Parameters

TMessage
The message type to send and receive

The PipeClientTMessage type exposes the following members.

Constructors
  NameDescription
Public methodPipeClientTMessage
Initializes a new instance of the PipeClientTMessage class
Top
Properties
  NameDescription
Public propertyId
A unique id for this Pipe
(Inherited from Pipe.)
Public propertyStream
The PipeStream on which to send and receive data
(Inherited from Pipe.)
Top
Methods
  NameDescription
Public methodConnect
Attempts to connect the pipe to a pipe server
Public methodConnectAsync
Attempts to asynchronously connect the pipe to a pipe server
Public methodStatic memberCreate
Creates a new PipeClient and attempts to connect the pipe to a pipe server
Public methodStatic memberCreateAsync
Creates a new PipeClient and attempts to asynchronously connect the pipe to a pipe server
Public methodDispose
Disconnects and disposes the pipe
(Inherited from Pipe.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodListen
Continuously waits for data from the pipe. The BytesReceived event is raised when data arrives, then immediately waits for more data.
(Inherited from Pipe.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDispose
Disconnects and disposes the pipe
(Inherited from Pipe.)
Protected methodOnListen
Continuously waits for data from the pipe. The BytesReceived event is raised when data arrives, then immediately waits for more data.
(Inherited from PipeTMessage.)
Protected methodOnStopListening
After the next bytes received, stops waiting for data
(Inherited from Pipe.)
Protected methodRaiseDisconnection
Raises the Disconnected event. Pass in an exception if desired.
(Inherited from Pipe.)
Protected methodRaiseMessageReceived
Called by the PipeExtensions extension methods to raise the MessageReceived event
(Inherited from PipeTMessage.)
Public methodStopListening
After the next bytes received, stops waiting for data
(Inherited from Pipe.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventConnected
Raised when a connection attempt succeeds
Public eventConnectionFailed
Raised when a connection attemp fails
Public eventDisconnected
Raised when the pipe has disconnected
(Inherited from Pipe.)
Public eventMessageReceived
Raised when a message has been received
(Inherited from PipeTMessage.)
Top
Fields
  NameDescription
Protected field_shouldListen (Inherited from Pipe.)
Top
Extension Methods
  NameDescription
Public Extension MethodCode exampleAsTType
Use Generic syntax for the as operator.
(Defined by AsExtensions.)
Public Extension MethodInitializeProperties

Scans the fields and properties of "owner" and sets the member's Owner property to "owner" This method should be called in the constructor of any class which has IOwnedProperty members

(Defined by PropertyHostExtensions.)
Public Extension MethodInLock(Action)Overloaded.
Performs the action in a Monitor lock
(Defined by MonitorExtensions.)
Public Extension MethodInLockTType(FuncTType)Overloaded.
Performs the function in a Monitor lock
(Defined by MonitorExtensions.)
Public Extension MethodInLockAsync(Action)Overloaded.
Asynchronously performs the action in a Monitor lock
(Defined by MonitorExtensions.)
Public Extension MethodInLockAsyncTType(FuncTType)Overloaded.
Asynchronously performs the action in a Monitor lock
(Defined by MonitorExtensions.)
Public Extension MethodIsDirty

Scans the IsDirty value of each field and property of type IProperty

(Defined by PropertyHostExtensions.)
Public Extension MethodLock
Performs a Monitor lock
(Defined by MonitorExtensions.)
Public Extension MethodMarkAsClean

Scans each field and property of type IProperty and sets it's IsDirty flag to false

(Defined by PropertyHostExtensions.)
Public Extension MethodReadTMessage
Waits for a message to be read from the pipe
(Defined by PipeReadWriteExtensions.)
Public Extension MethodReadAsyncTMessage
Waits for a message to be read from the pipe
(Defined by PipeReadWriteExtensions.)
Public Extension MethodUnlock
Performs a Monitor unlock
(Defined by MonitorExtensions.)
Public Extension MethodWriteTMessage
Write a message to the pipe
(Defined by PipeReadWriteExtensions.)
Public Extension MethodWriteAsyncTMessage
Asynchronously write a message to the pipe
(Defined by PipeReadWriteExtensions.)
Top
See Also