Mtf.Network 1.0.4

Mtf.Network Library Documentation

Overview

The Mtf.Network library provides functionality for creating and managing inter-process communication using named pipes. It includes the PipeServer and PipeClient classes, which facilitate sending and receiving messages asynchronously. This document covers installation, class properties, methods, events, and usage examples for integrating with named pipes in .NET applications.

Installation

To use Mtf.Network, add the package to your project:

1. Add Package: Run the following in your project directory:

   dotnet add package Mtf.Network
   

2. Include the Namespace: Add the Mtf.Network namespace at the beginning of your code:

   using Mtf.Network;
   

Class: Client

The Client class facilitates TCP-based communication with a server. It is designed for ease of use, supporting features like connection timeouts, message encoding, and data handling.

Constructor

Client(string serverHost, ushort listenerPort, AddressFamily addressFamily = AddressFamily.InterNetwork, SocketType socketType = SocketType.Stream, ProtocolType protocolType = ProtocolType.Tcp)

Initializes a new instance of the Client class and sets up a socket for communication.

Parameters:

• serverHost: The hostname or IP address of the server to connect to.
• listenerPort: The port on which the server listens for connections.
• addressFamily (optional): Specifies the addressing scheme (e.g., IPv4 or IPv6). Default is AddressFamily.InterNetwork.
• socketType (optional): Defines the socket type (e.g., Stream or Dgram). Default is SocketType.Stream.
• protocolType (optional): Specifies the protocol (e.g., TCP or UDP). Default is ProtocolType.Tcp.

Properties

Methods

Connection Management

• Connect()
  Establishes a connection to the server using the provided hostname and port. Throws a ConnectionFailedException if the connection cannot be established within the specified timeout.

Message Handling

• Send(string message, bool appendNewLine = false)
  Sends a message to the connected server. Optionally appends a newline to the message.

  • message: The message to be sent.
  • appendNewLine (optional): If true, appends a newline (Environment.NewLine) to the message.

Resource Management

• Dispose() (override)
  Releases managed resources, closes the socket, and cancels any active tasks.

Events

The Client class inherits events from the Communicator base class:

• OnDataArrived(Socket socket, byte[] data)
  Triggered when data is received from the server.

• OnMessageSent(string message)
  Triggered after a message is successfully sent.

Protected Methods

• DisposeManagedResources()
  Cleans up managed resources during disposal, including canceling tasks and closing the socket.

Example Usage

using Mtf.Network;
using System;

class Program
{
    static void Main()
    {
        // Create a client instance
        var client = new Client("127.0.0.1", 8080);

        try
        {
            // Connect to the server
            client.Connect();
            Console.WriteLine("Connected to server.");

            // Send a message
            client.Send("Hello, server!", appendNewLine: true);
            Console.WriteLine("Message sent to server.");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
        finally
        {
            // Dispose the client
            client.Dispose();
            Console.WriteLine("Client disposed.");
        }
    }
}

Class: PipeServer

The PipeServer class is responsible for handling server-side functionality for named pipes. It accepts connections, listens for messages, and sends data asynchronously to connected clients.

Constructor

PipeServer()

• Initializes a new instance of the PipeServer class.

Properties

Methods

Server Management

• Start()
  Starts the pipe server, waits for client connections, and begins reading incoming messages asynchronously.

• Stop()
  Stops the pipe server, canceling any active operations.

Message Sending

• SendAsync(string message)
  Sends a message asynchronously to the connected pipe client. Throws an exception if the server is not started or the message is null.

Resource Management

• Dispose()
  Disposes of the resources used by the PipeServer class, including canceling any active tasks and cleaning up the StreamWriter.

Events

• MessageReceived
  Occurs when a message is received from the client.

  EventArgs: MessageEventArgs

  • Contains the received message.

• ErrorOccurred
  Occurs when an error occurs during communication or server operation.

  EventArgs: ExceptionEventArgs

  • Contains the exception details.

Example Usage

using Mtf.Network;
using System;
using System.Threading.Tasks;

public class PipeServerExample
{
    public async Task Example()
    {
        // Create a new PipeServer instance
        var pipeServer = new PipeServer { PipeName = "TestPipe" };

        // Subscribe to the MessageReceived event
        pipeServer.MessageReceived += (sender, e) => 
        {
            Console.WriteLine($"Received message: {e.Message}");
        };

        // Start the pipe server
        pipeServer.Start();

        // Send a message asynchronously
        await pipeServer.SendAsync("Hello from the server!");

        // Stop the pipe server
        pipeServer.Stop();
    }
}

Class: PipeClient

The PipeClient class is responsible for managing client-side functionality for named pipes. It connects to a pipe server, sends messages, and listens for incoming messages asynchronously.

Constructor

PipeClient()

• Initializes a new instance of the PipeClient class.

Properties

Methods

Client Management

• ConnectAsync()
  Connects to the server's named pipe asynchronously. If the connection fails, the ErrorOccurred event is triggered.

• Disconnect()
  Disconnects from the named pipe server and releases resources.

Message Sending and Receiving

• SendAsync(string message, CancellationToken cancellationToken = default)
  Sends a message asynchronously to the connected pipe server. Throws an exception if the connection fails.

• ReceiveAsync(int bufferSize = 1024, CancellationToken cancellationToken = default)
  Receives a message asynchronously from the pipe server. Returns the received message as a string.

Listening for Messages

• StartListening(int bufferSize = 1024)
  Starts listening for incoming messages from the server.

• StopListening()
  Stops the listening operation.

Resource Management

• Dispose()
  Disposes of the resources used by the PipeClient class, including canceling active operations.

Events

• MessageReceived
  Occurs when a message is received from the server.

  EventArgs: MessageEventArgs

  • Contains the received message.

• ErrorOccurred
  Occurs when an error occurs during communication or client operation.

  EventArgs: ExceptionEventArgs

  • Contains the exception details.

Example Usage

using Mtf.Network;
using System;
using System.Threading;
using System.Threading.Tasks;

public class PipeClientExample
{
    public async Task Example()
    {
        // Create a new PipeClient instance
        var pipeClient = new PipeClient { PipeName = "TestPipe" };

        // Subscribe to the MessageReceived event
        pipeClient.MessageReceived += (sender, e) => 
        {
            Console.WriteLine($"Received message: {e.Message}");
        };

        // Connect to the server
        await pipeClient.ConnectAsync();

        // Send a message asynchronously
        await pipeClient.SendAsync("Hello from the client!");

        // Receive a message from the server
        var receivedMessage = await pipeClient.ReceiveAsync();
        Console.WriteLine($"Received message: {receivedMessage}");

        // Start listening for incoming messages
        pipeClient.StartListening();

        // Wait for a message
        await Task.Delay(1000);

        // Stop listening
        pipeClient.StopListening();

        // Disconnect from the server
        pipeClient.Disconnect();
    }
}

Notes

• Exception Handling: Ensure exception handling is in place for communication errors during connection, sending, or receiving data.
• Dispose: Always dispose of the PipeClient and PipeServer instances to free up resources after use.
• Listening: If you want to continuously listen for messages, make sure to call StartListening() and StopListening() when appropriate.