SerfWrapper 1.0.0

SerfWrapper NuGet Package

Overview

SerfWrapper is a .NET wrapper for HashiCorp Serf, providing cluster membership, failure detection, and orchestration functionality. This NuGet package allows you to easily integrate Serf into your .NET applications.

Installation

Install the SerfWrapper package from NuGet:

dotnet add package SerfWrapper

Or via the NuGet Package Manager:

Install-Package SerfWrapper

Basic Usage

using System;
using System.Threading.Tasks;
using SerfWrapper;

// Create a log handler
LogHandler logHandler = (message, level) => 
    Console.WriteLine($"[{level}] {message}");

// Register for log events
SerfAgent.OnLog += logHandler;

// Register for user events
SerfAgent.OnUserEvent += (name, payload, coalesce) => 
    Console.WriteLine($"Received user event: {name}, payload: {payload}, coalesce: {coalesce}");

// Define encryption key and RPC token
string encryptionKey = "your-encryption-key";
string rpcToken = "your-rpc-token";

// Start the Serf agent
int result = SerfAgent.StartSerfAgent(
    bindAddr: "127.0.0.1",
    bindPort: 7946,
    nodeName: "my-node",
    encryptionKey: encryptionKey,
    rpcToken: rpcToken);

if (result == 0)
{
    Console.WriteLine("Serf agent started successfully");
    
    // Send a user event
    SerfAgent.SendUserEvent("test-event", "Hello from SerfWrapper!", 0); // 0 for false, 1 for true
    
    // Get the cluster members
    var members = SerfAgent.GetMembers();
    foreach (var member in members)
    {
        Console.WriteLine($"{member.Name} at {member.Address}, Status: {member.Status}");
    }
    
    // Join another node to the cluster
    SerfAgent.JoinCluster("192.168.1.100", 7946);
    
    // Stop the Serf agent when done
    SerfAgent.StopSerfAgent();
}

Features

• Start and manage Serf agents
• Join and leave Serf clusters
• Send and receive user events
• Query cluster members
• Handle logs and events
• Secure communication with encryption and authentication

Requirements

• .NET 8.0 or later
• Supported platforms: Linux, macOS
  • Native libraries for both Linux (x64) and macOS (x64) are included in the package
  • Windows support may be added in future releases

Security Considerations

• The Serf cluster communication is encrypted using the provided encryption key
• RPC communication can be authenticated using an RPC token
• Always use secure, randomly generated keys for production use

License

This package is licensed under the MIT License.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.