README_EN.md

Introduction

This is a simple network library for Go.

It focus on packet based persistent connection communication.

It provide a packet splitting protocol like Erlang's {packet: N} in default. And supported custom packet splitting protocol.

But it didn't limit the encode or decode format of the request and response.

Also this library provide session management and broadcast features to make your life easy.

How to install

go get github.com/funny/link

How to use

Setup a server on port 8080.

server, _ := link.Listen("tcp", "0.0.0.0:8080")

Handle incoming connections. And setup a message handler on the new session.

server.Serve(func(session *link.Session) {
	fmt.Println("session start")

	session.Process(func(msg *link.InBuffer) error {
		fmt.Printf("new message: %s\n", msg)
		return nil
	})

	fmt.Println("session closed")
})

Client dial to the server.

client, _ := link.Dial("tcp", "127.0.0.1:8080")

Send a message to server.

client.Send(link.Bytes("Hello World!"))

Examples

• Echo server
• Echo client
• Broadcast server
• Benchmark tool

Document

Let's Go!