https://github.com/theopnv/bladenetwork

A simple and lightweight C# asynchronous networking library
https://github.com/theopnv/bladenetwork

asynchronous blade-runner client csharp dotnet network observer-pattern server tcp

Last synced: about 7 hours ago
JSON representation

A simple and lightweight C# asynchronous networking library

• Host: GitHub
• URL: https://github.com/theopnv/bladenetwork
• Owner: theopnv
• Created: 2017-12-22T23:03:24.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-28T15:37:36.000Z (over 6 years ago)
• Last Synced: 2024-11-08T04:50:03.130Z (11 days ago)
• Topics: asynchronous, blade-runner, client, csharp, dotnet, network, observer-pattern, server, tcp
• Language: C#
• Size: 609 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Blade Network.NET](Documentation/Readme/blade-network.png "Blade Network.NET")

[![Build status](https://ci.appveyor.com/api/projects/status/4a3b1ytxff7bf7q1?svg=true)](https://ci.appveyor.com/project/theo-pnv/bladenetwork)

![NuGet](https://img.shields.io/nuget/v/Nuget.Core.svg)

![license](https://img.shields.io/github/license/mashape/apistatus.svg)

## Description

This is a simple and lightweight C# asynchronous networking library.

It is named after a famous SF classic, because it is as strong and reliable as replicants.

### Features

- *Very simple to use !*

  - Just a few instructions, explained in the documentation below.

  - Easy to add as a reference (DLL) for an external project.

- TCP based implementation

- Efficiency (asynchronous read & write)

- Events raised at each reception of a message, for further processing (Observer pattern)

It works very well with Netwonsoft (https://www.newtonsoft.com/json). With this package installed, you are able to pass complex objects between server and client.

## Getting started

A Nuget package is available : https://www.nuget.org/packages/BladeNetwork/

There is a complete & well-documented example available in the `Examples` directory.

It shows a very basic implementation of a running server and associated client.

### Server-side [(Example)](Examples/BladeServer/Server.cs)

**Initialization:**

    var server = new blade.Server(ip, port, MsgHandler);

**Send messages:**

    server.Send(target, "Hello from server !");

**Receive messages:**

Implement the `MsgHandler` function : it will be called each time a message is received by the server.

You can then parse it there.

### Client-side [(Example)](Examples/BladeClient/Client.cs)

**Initialization:**

    var client = new blade.Client(ip, port, MsgHandler);

**Send messages:**

    client.Send("Hello from client !");

**Receive messages:**

Implement the `MsgHandler` function : it will be called each time a message is received by the server.

You can then parse it there.

It's as simple as that !