| # getty |
| |
| *a netty like asynchronous network I/O library* |
| |
| [](https://travis-ci.org/dubbogo/getty) |
| [](https://codecov.io/gh/dubbogo/getty) |
| [](https://pkg.go.dev/github.com/dubbogo/getty?tab=doc) |
| [](https://goreportcard.com/report/github.com/dubbogo/getty) |
|  |
| |
| ## INTRO |
| |
| Getty is a asynchronous network I/O library in golang. Getty works on tcp/udp/websocket network protocol and supplies [a uniform interface](https://github.com/dubbogo/getty/blob/master/getty.go#L45). |
| |
| In getty there are two goroutines in one connection(session), one reads tcp stream/udp packet/websocket package, the other handles logic process and writes response into network write buffer. If your logic process may take a long time, you should start a new logic process goroutine by yourself in codec.go:(Codec)OnMessage. |
| |
| You can also handle heartbeat logic in codec.go:(Codec):OnCron. If you use tcp/udp, you should send hearbeat package by yourself, and then invoke session.go:(Session)UpdateActive to update its active time. Please check whether the tcp session has been timeout or not in codec.go:(Codec)OnCron by session.go:(Session)GetActive. |
| |
| Whatever if you use websocket, you do not need to care about hearbeat request/response because Getty do this task in session.go:(Session)handleLoop by sending/received websocket ping/pong frames. You just need to check whether the websocket session has been timeout or not in codec.go:(Codec)OnCron by session.go:(Session)GetActive. |
| |
| ## LICENCE |
| |
| Apache License 2.0 |
| |
