https://github.com/surereddy/mnet

Mnet provides blazing fast network packages.
https://github.com/surereddy/mnet

Last synced: 12 days ago
JSON representation

Mnet provides blazing fast network packages.

• Host: GitHub
• URL: https://github.com/surereddy/mnet
• Owner: surereddy
• License: mit
• Created: 2018-02-05T06:22:29.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-25T11:29:40.000Z (almost 7 years ago)
• Last Synced: 2024-08-02T05:12:17.770Z (3 months ago)
• Language: Go
• Homepage:
• Size: 4.18 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - mnet - Mnet provides blazing fast network packages. (Go)

README

        
MNet

------

[![Go Report Card](https://goreportcard.com/badge/github.com/influx6/mnet)](https://goreportcard.com/report/github.com/influx6/mnet)

[![Travis CI](https://travis-ci.org/influx6/mnet.svg?master=branch)](https://travis-ci.org/influx6/mnet)

[![Circle CI](https://circleci.com/gh/influx6/mnet.svg?style=svg)](https://circleci.com/gh/influx6/mnet)

Mnet is a collection of superfast networking packages with implementations from ontop of `tcp`, `udp`, and others as planned. It exists to provide a lightweight foundation where other higher level APIs can 

be built on.

## Install

```

go get -v github.com/influx6/mnet/...

```

## Design

Mnet presents a flexible design in the approach of hpw structures are built. The `mnet.Client` is a special case which is shared among the differing protocols of `tcp`, `udp` and `websocket`. Each provides the `mnet.Client` struct with appropriate methods to allow the client perform the expected operations required.

This approach allows a massive level of flexibility and easily lets us swap in like lego blocks methods to power the underline protocol operations.

## Protocols Implemented

### TCP

Mnet provides the [mtcp](./mtcp) package which implements a lightweight tcp server and client implementations with blazing fast data transfers by combining minimal data copy with data buffering techniques. 

Mtcp like all Mnet packages are foundation, in that they lay the necessary foundation to transfer at blazing speed without being too opinionated on how you build on top.

See [MTCP](./mtcp) for more.

### UDP

Mnet provides the [mudp](./mudp) package which implements a lightweight udp server and client implementations with blazing fast data transfers by combining minimal data copy with data buffering techniques. 

Mudp like all Mnet packages are foundation, in that they lay the necessary foundation to transfer at blazing speed without being too opinionated on how you build on top.

### Websockets

Mnet provides the [msocks](./msocks) package which implements a lightweight websocket server and client implementations with blazing fast data transfers by combining minimal data copy with data buffering techniques. 

Msocks like all Mnet packages are foundation, in that they lay the necessary foundation to transfer at blazing speed without being too opinionated on how you build on top.

## Contributions

1. Fork this repository to your own GitHub account and then clone it to your local device

2. Make your changes with clear git commit messages.

3. Create a PR request with detail reason for change.

Do reach out anything, if PR takes time for review. :)