Tungsten
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
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
Name | Description | |
---|---|---|
PipeClientTMessage | Initializes a new instance of the PipeClientTMessage class |
Properties
Name | Description | |
---|---|---|
Id |
A unique id for this Pipe
(Inherited from Pipe.) | |
Stream |
The PipeStream on which to send and receive data
(Inherited from Pipe.) |
Methods
Name | Description | |
---|---|---|
Connect |
Attempts to connect the pipe to a pipe server
| |
ConnectAsync |
Attempts to asynchronously connect the pipe to a pipe server
| |
Create |
Creates a new PipeClient and attempts to connect the pipe to a pipe server
| |
CreateAsync |
Creates a new PipeClient and attempts to asynchronously connect the pipe to a pipe server
| |
Dispose |
Disconnects and disposes the pipe
(Inherited from Pipe.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Listen |
Continuously waits for data from the pipe. The BytesReceived event is raised when data arrives, then immediately waits for more data.
(Inherited from Pipe.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnDispose |
Disconnects and disposes the pipe
(Inherited from Pipe.) | |
OnListen |
Continuously waits for data from the pipe. The BytesReceived event is raised when data arrives, then immediately waits for more data.
(Inherited from PipeTMessage.) | |
OnStopListening |
After the next bytes received, stops waiting for data
(Inherited from Pipe.) | |
RaiseDisconnection |
Raises the Disconnected event. Pass in an exception if desired.
(Inherited from Pipe.) | |
RaiseMessageReceived |
Called by the PipeExtensions extension methods to raise the MessageReceived event
(Inherited from PipeTMessage.) | |
StopListening |
After the next bytes received, stops waiting for data
(Inherited from Pipe.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
Name | Description | |
---|---|---|
Connected |
Raised when a connection attempt succeeds
| |
ConnectionFailed |
Raised when a connection attemp fails
| |
Disconnected |
Raised when the pipe has disconnected
(Inherited from Pipe.) | |
MessageReceived |
Raised when a message has been received
(Inherited from PipeTMessage.) |
Fields
Name | Description | |
---|---|---|
_shouldListen | (Inherited from Pipe.) |
Extension Methods
Name | Description | |
---|---|---|
AsTType |
Use Generic syntax for the as operator.
(Defined by AsExtensions.) | |
InitializeProperties | 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 | |
InLock(Action) | Overloaded.
Performs the action in a Monitor lock
(Defined by MonitorExtensions.) | |
InLockTType(FuncTType) | Overloaded.
Performs the function in a Monitor lock
(Defined by MonitorExtensions.) | |
InLockAsync(Action) | Overloaded.
Asynchronously performs the action in a Monitor lock
(Defined by MonitorExtensions.) | |
InLockAsyncTType(FuncTType) | Overloaded.
Asynchronously performs the action in a Monitor lock
(Defined by MonitorExtensions.) | |
IsDirty | Scans the IsDirty value of each field and property of type IProperty | |
Lock |
Performs a Monitor lock
(Defined by MonitorExtensions.) | |
MarkAsClean | Scans each field and property of type IProperty and sets it's IsDirty flag to false | |
ReadTMessage |
Waits for a message to be read from the pipe
(Defined by PipeReadWriteExtensions.) | |
ReadAsyncTMessage |
Waits for a message to be read from the pipe
(Defined by PipeReadWriteExtensions.) | |
Unlock |
Performs a Monitor unlock
(Defined by MonitorExtensions.) | |
WriteTMessage |
Write a message to the pipe
(Defined by PipeReadWriteExtensions.) | |
WriteAsyncTMessage |
Asynchronously write a message to the pipe
(Defined by PipeReadWriteExtensions.) |
See Also