PipesConnection

Remarks

Manages a connection between a server and a client. PipesServer creates one for each client and passes it to its ClientConnected, ClientDisconnected and ClientMessage events.

---

Constructors

Syntax	Description
PipesConnection(int id, string name, PipeStream serverStream)	Constructor that passes the stream from the server, plus any identifiers.

---

Properties

Identifier	Type	Description
ID	int	Numeric identifier. A read-only field.
IsConnected	bool	Indicates if stream is connected.
Name	string	String identifier for the client in this connected stream.
TheStream	PipeStream	The stream between server and client.

---

Events

Identifier	Type	Description
Disconnected	PipeConnectionEvent	Indicates the stream has been disconnected.
Error	PipeConnectionExceptionEvent	Indicates an error.
ReceiveMessage	PipeConnectionMessageEvent	Indicates that the stream received a message.

---

Methods

Method	Returns	Description
Close()	void	Closes the stream.
Open()	void	Opens the connection for reading and writing.
Send(PipeMessage message)	void	Puts a PipeMessage in the queue to be sent.

---

Delegates

Delegate	Returns	Description
PipeConnectionEvent(PipesConnection pc)	void	Handles a connection state event, such as disconnection.
PipeConnectionMessageEvent(PipesConnection pc, PipeMessage message)	void	Handles a message received on a connection.
PipeConnectionExceptionEvent(PipesConnection pc, Exception ex)	void	Handles an error on a connection.

---

Example

using Nova.IPC.Pipes;

PipesServer server = new PipesServer("NovaDemoServer");

// The server passes each client's PipesConnection to its events.
server.ClientConnected += connection =>
{
  Console.WriteLine(connection.Name + " connected: " + connection.IsConnected);

  PipeMessage welcome = new PipeMessage();
  welcome.EncodeString("Welcome.");
  connection.Send(welcome);
};

server.Start();