Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parinpan/protoevent
ProtoEvent is an event-based TCP connection handling library for Go.
https://github.com/parinpan/protoevent
client event-handlers golang server tcp udp
Last synced: about 4 hours ago
JSON representation
ProtoEvent is an event-based TCP connection handling library for Go.
- Host: GitHub
- URL: https://github.com/parinpan/protoevent
- Owner: parinpan
- Created: 2020-05-06T09:53:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-13T11:19:09.000Z (over 4 years ago)
- Last Synced: 2024-06-20T14:27:12.625Z (8 months ago)
- Topics: client, event-handlers, golang, server, tcp, udp
- Language: Go
- Homepage:
- Size: 63.5 KB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ProtoEvent is an event-based TCP connection handling library in Golang. It's simple and not exploiting too much the basic functionality of making a new protocol connection. ProtoEvent reimplements `net.Listener` and `net.Conn` interface to have extended ability of capturing various events that happened in network communication.
# Background
It's painful enough when you have to look after your simple network application codebase which is not well-organized ends up with producing more spaghetti code. At least, we're now able to organize application logics based on a certain network event.
# Installation
```
go get -u https://github.com/parinpan/protoevent
```
# Demo
# Examples
Server side application:
```golang
package main
import (
"encoding/json"
"fmt"
"net"
"github.com/parinpan/protoevent"
)
type Message struct {
From string `json:"from"`
}
func main() {
servant, event, err := protoevent.CreateServant("tcp", "0.0.0.0:8089")
if nil != err {
panic(err)
}
event.OnConnectionError(func(err error) {
})
event.OnConnectionAccepted(func(conn net.Conn) {
fmt.Println("Accepting new connection: ", conn.RemoteAddr())
})
event.OnConnectionClosed(func(conn net.Conn) {
})
event.OnReceiveMessageError(func(conn net.Conn, err error) {
})
event.OnMessageReceived(func(conn net.Conn, message []byte, rawMessage []byte) {
fmt.Println("Received a message: ", string(message))
var msg Message
_ = json.Unmarshal(message, &msg)
// send a message back to client
sayHiMessage := fmt.Sprint("Hi ", msg.From, ". Welcome to ProtoEvent!")
conn.Write([]byte(sayHiMessage))
})
event.OnSendMessageError(func(conn net.Conn, message []byte, err error) {
})
event.OnMessageSent(func(conn net.Conn, message []byte) {
fmt.Println("Sent a message: ", string(message))
})
servant.SetDefaultReadSize(4096) // set default read size per chunk in bytes
servant.Serve()
}
```
Client side application:
```golang
package main
import (
"fmt"
"net"
"github.com/parinpan/protoevent"
)
func main() {
agent, event := protoevent.CreateAgent("tcp", "0.0.0.0:8089")
agent.SetDefaultReadSize(4096) // set default read size per chunk in bytes
event.OnConnectionError(func(err error) {
})
event.OnConnectionAccepted(func(conn net.Conn) {
fmt.Println("Accepting new connection: ", conn.RemoteAddr())
})
event.OnConnectionClosed(func(conn net.Conn) {
})
event.OnReceiveMessageError(func(conn net.Conn, err error) {
})
event.OnMessageReceived(func(conn net.Conn, message []byte, rawMessage []byte) {
fmt.Println("Received a message: ", string(message))
})
event.OnSendMessageError(func(conn net.Conn, message []byte, err error) {
})
event.OnMessageSent(func(conn net.Conn, message []byte) {
fmt.Println("Sent a message: ", string(message))
})
// trigger a message to get connected with the server at first
err := agent.Run(func(conn net.Conn) error {
_, err := conn.Write([]byte(`{"from": "AgentV1"}`))
return err
})
if nil != err {
panic(err)
}
}
```
# Contact Me
If you have any inquiries. You can catch me up on:
- [Linkedin](https://linkedin.com/in/fachrinfan)
- [Twitter](https://twitter.com/fachrinfan)
- [Instagram](https://instagram.com/fachrinfan)
- [Email](mailto:[email protected])