OutWit.Communication.Server 1.0.0

OutWit.Communication.Server

Overview

The OutWit.Communication.Server library provides a powerful framework for creating servers in the WitCom ecosystem. It supports encryption, token-based authorization, and flexible serialization to ensure secure and efficient communication with clients.

Features

1. Authorization

• AccessTokenValidatorPlain: No token validation for unauthenticated scenarios.
• AccessTokenValidatorStatic: Static token validation for predefined secure access.

Example:

var server = WitComServerBuilder.Build(options =>
{
    options.WithAccessToken("your-access-token");
});

2. Encryption

• EncryptorServerPlain: No encryption for lightweight communication.
• EncryptorServerGeneral: AES encryption for secure data exchange.

Example:

var server = WitComServerBuilder.Build(options =>
{
    options.WithEncryption();
});

3. Serialization

• JSON: Default format, ideal for debugging and compatibility.
• MessagePack: High-performance, compact binary serialization.

Example:

var server = WitComServerBuilder.Build(options =>
{
    options.WithJson();
});

// Or for MessagePack:
var server = WitComServerBuilder.Build(options =>
{
    options.WithMessagePack();
});

4. Logging and Debugging

Integrate custom logging for debugging and monitoring:

var server = WitComServerBuilder.Build(options =>
{
    options.WithLogger(new ConsoleLogger());
});

5. Timeout Configuration

Set request and response timeouts for server operations:

var server = WitComServerBuilder.Build(options =>
{
    options.WithTimeout(TimeSpan.FromSeconds(30));
});

6. Service Support

Expose your services seamlessly using the WithService configuration.

Example:

var server = WitComServerBuilder.Build(options =>
{
    options.WithService(new MyService());
});

Installation

Install the package via NuGet. Note: You also need to install the specific transport package you intend to use (e.g., OutWit.Communication.Server.Tcp, OutWit.Communication.Server.WebSocket, etc.):

Install-Package OutWit.Communication.Server

Getting Started

Basic Setup

var server = WitComServerBuilder.Build(options =>
{
    options.WithAccessToken("my-access-token");
    options.WithEncryption();
    options.WithJson();
    options.WithTimeout(TimeSpan.FromSeconds(10));
    options.WithService(new MyService());
});

server.StartWaitingForConnection();

Stopping the Server

server.StopWaitingForConnection();

Handling Requests

Define your service to process client requests:

public class MyService
{
    public string Greet(string name)
    {
        return $"Hello, {name}!";
    }
}

Clients can invoke this service:

var request = new WitComRequest
{
    MethodName = "Greet",
    Parameters = new object[] { "John" }
};

API Reference

WitComServer

The core class for server-side communication.

Key Methods:

• StartWaitingForConnection: Begins listening for client connections.
• StopWaitingForConnection: Stops the server and releases resources.

WitComServerBuilder

A fluent API for configuring and creating WitComServer instances.

Configuration Options:

• .WithAccessToken: Sets the access token for authentication.
• .WithEncryption: Enables encryption for secure communication.
• .WithJson: Configures JSON serialization.
• .WithMessagePack: Configures MessagePack serialization.
• .WithTimeout: Sets the timeout duration.
• .WithService: Exposes a service for client requests.