Skip to content

fitchle/sockets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

Benchion Sockets Library

An netty based asynchronous socket library for benchion java applications
📖 Documents 📖

Report Bug · Request Feature



Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact
  6. Contributors

📗 About The Project

Benchion Socket Library is an understandable asynchronous java library made to make your netty work easier.

Here's why:

  • It is an easy to use library, no need to waste time anymore!
  • It is an understandable library.
  • It is an asynchronous library.

Built With

In this project, netty was used as socket library, gson was used as json library, lombok was used as code generation library.

🌙 Getting Started

✨ Installation

  1. Firstly clone this project with Git
   git clone https://github.com/Benchion/sockets.git
  1. Read the documents
  2. Code, code, code!

⚡ Usage

Creating Server

  BenchionSocketServer server = new BenchionSocketServer(8888); // Creates a server
  server.build().run(); // Builds and runs the server

Creating Client & Connect a Server

  BenchionSocketClient client = new BenchionSocketClient("hostname", 8888); // Creates a client
  client.build().connect(); // Builds and connects to server

For more examples, please refer to the Documentation

🔐 License

Distributed under the MIT License. See LICENSE for more information.

📞 Contact

🧑🏻‍💻 Contributors