commit | 32af5a7ff2da965ed561f6a775546ca75b17c765 | [log] [tgz] |
---|---|---|
author | iSuperCoder <liu.wenshao@163.com> | Thu Jul 27 19:16:09 2023 +0800 |
committer | iSuperCoder <liu.wenshao@163.com> | Thu Jul 27 19:16:09 2023 +0800 |
tree | e525c1aca6e2d4613a08ff2a9df9db24dfe283aa | |
parent | 33a17aa4a5eb45ceb0d87f5ad3f3045be78a92fe [diff] |
refactor: Adding comments to exported interface methods.
a netty like asynchronous network I/O library
Getty is a asynchronous network I/O library in golang. Getty works on tcp/udp/websocket network protocol and supplies a uniform interface.
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.
Apache License 2.0