Skip to content

Latest commit

 

History

History
227 lines (181 loc) · 5.73 KB

doc.md

File metadata and controls

227 lines (181 loc) · 5.73 KB
Raw

handy

yedongfu

Handy是一个简洁高效的C++11网络库，支持linux与mac平台，使用异步IO模型

使用示例
EventBase事件分发器
tcp连接
tcp服务器
http服务器
半同步半异步服务器

使用示例--echo

#include <handy/handy.h>

using namespace std;
using namespace handy;


int main(int argc, const char* argv[]) {
    EventBase base; //事件分发器
    //注册Ctrl+C的信号处理器--退出事件分发循环
    Signal::signal(SIGINT, [&]{ base.exit(); }); 
    TcpServer echo(&base); //创建服务器
    int r = echo.bind("", 2099); //绑定端口
    exitif(r, "bind failed %d %s", errno, strerror(errno));
    echo.onConnRead([](const TcpConnPtr& con) {
        con->send(con->getInput()); // echo 读取的数据
    });
    base.loop(); //进入事件分发循环
}

EventBase事件分发器

EventBase是事件分发器，内部使用epoll/kqueue来管理非阻塞IO 
EventBase base;

事件分发循环

//不断调用epoll_wait，处理IO事件
base.loop();

退出事件循环

//退出事件循环，线程安全，可在其他线程中调用
base.exit();

是否已退出

bool exited();

在IO线程中执行任务

一些任务必须在IO线程中完成，例如往连接中写入数据。非IO线程需要往连接中写入数据时，必须把任务交由IO线程进行处理

void safeCall(const Task& task);

base.safeCall([con](){con->send("OK");});

例子程序

管理定时任务

EventBase通过设定epoll_wait/kevent的等待时间让自己及时返回，然后检查是否有到期的任务，因此时间精度依赖于epoll_wait/kevent的精度

//interval: 0：一次性任务；>0：重复任务，每隔interval毫秒，任务被执行一次
TimerId runAfter(int64_t milli, const Task& task, int64_t interval=0);
//runAt则指定执行时刻
TimerId runAt(int64_t milli, const Task& task, int64_t interval=0)
//取消定时任务，若timer已经过期，则忽略
bool cancel(TimerId timerid);

TimerId tid = base.runAfter(1000, []{ info("a second passed"); });
base.cancel(tid);

例子程序

TcpConn tcp连接

连接采用引用计数的方式进行管理，因此用户无需手动释放连接 ### 引用计数 
typedef std::shared_ptr<TcpConn> TcpConnPtr;

状态

enum State { Invalid=1, Handshaking, Connected, Closed, Failed, };

创建连接

TcpConnPtr con = TcpConn::createConnection(&base, host, port); #第一个参数为前面的EventBase*

使用示例

TcpConnPtr con = TcpConn::createConnection(&base, host, port);
con->onState([=](const TcpConnPtr& con) {
    info("onState called state: %d", con->getState());
});
con->onRead([](const TcpConnPtr& con){
    info("recv %lu bytes", con->getInput().size());
    con->send("ok");
    con->getInput().clear();
});

例子程序

设置重连

//设置重连时间间隔，-1: 不重连，0:立即重连，其它：等待毫秒数，未设置不重连
void setReconnectInterval(int milli);

例子程序

连接空闲回调

void addIdleCB(int idle, const TcpCallBack& cb);

//连接空闲30s关闭连接
con->addIdleCB(30, [](const TcpConnPtr& con)) { con->close(); });

例子程序

消息模式

可以使用onRead处理消息，也可以选用onMsg方式处理消息

//消息回调，此回调与onRead回调只有一个生效，后设置的生效
//codec所有权交给onMsg
void onMsg(CodecBase* codec, const MsgCallBack& cb);
//发送消息
void sendMsg(Slice msg);

con->onMsg(new LineCodec, [](const TcpConnPtr& con, Slice msg) {
    info("recv msg: %.*s", (int)msg.size(), msg.data());
    con->sendMsg("hello");
});

例子程序

存放自定义数据

template<class T> T& context();

con->context<std::string>() = "user defined data";

TcpServer tcp服务器

创建tcp服务器

TcpServer echo(&base);

使用示例

TcpServer echo(&base); //创建服务器
int r = echo.bind("", 2099); //绑定端口
exitif(r, "bind failed %d %s", errno, strerror(errno));
echo.onConnRead([](const TcpConnPtr& con) {
    con->send(con->getInput()); // echo 读取的数据
});

例子程序

自定义创建的连接

当服务器accept一个连接时，调用此函数

void onConnCreate(const std::function<TcpConnPtr()>& cb);

chat.onConnCreate([&]{
    TcpConnPtr con(new TcpConn);
    con->onState([&](const TcpConnPtr& con) {
        if (con->getState() == TcpConn::Connected) {
            con->context<int>() = 1;
        }
    }
    return con;
});

例子程序

HttpServer http服务器

//使用示例
HttpServer sample(&base);
int r = sample.bind("", 8081);
exitif(r, "bind failed %d %s", errno, strerror(errno));
sample.onGet("/hello", [](const HttpConnPtr& con) {
   HttpResponse resp;
   resp.body = Slice("hello world");
   con.sendResponse(resp);
});

例子程序

半同步半异步服务器

//cb返回空string，表示无需返回数据。如果用户需要更灵活的控制，可以直接操作cb的con参数
void onMsg(CodecBase* codec, const RetMsgCallBack& cb);

hsha.onMsg(new LineCodec, [](const TcpConnPtr& con, const string& input){
    int ms = rand() % 1000;
    info("processing a msg");
    usleep(ms * 1000);
    return util::format("%s used %d ms", input.c_str(), ms);
});

例子程序

持续更新中......