跨平台C++通过libevent实现高并发网络编程

chocolate7777777

已于 2023-06-09 16:00:45 修改

阅读量649

点赞数

分类专栏： C/C++编程文章标签： c++ 开发语言网络 linux

于 2023-06-09 15:59:24 首次发布

本文链接：https://blog.csdn.net/qq_40321622/article/details/131125779

版权

C/C++编程专栏收录该内容

31 篇文章 0 订阅

订阅专栏

Libevent 是一个用C语言编写的、轻量级的开源高性能事件通知库，已经被广泛的应用，作为底层的网络库，可适用于多种平台。该项目使用了libevent的库。

为了实现高性能的服务端，用了异步处理网络IO+多线程。

启动一个专门用来accept客户端的线程，启动指定个数的工作线程用来处理与客户端的具体业务，accept线程将收到的客户端随机分发到工作线程中，每个工作线程可能处理一个或多个与客户端的交互。

TcpServer.h

//TCP服务基础类
	class TcpServer
	{
	private:
		int m_ThreadCount;					//子线程数
		int m_Port;							//监听的端口
		LibeventThread *m_MainBase;			//accept线程的libevent事件处理机
		LibeventThread *m_Threads;			//存储各个工作子线程信息的数组
		map<int, event*> m_SignalEvents;	//自定义的信号处理		
		
	public:
		static const int EXIT_CODE = -1;

	private:
		//初始化子线程的数据
		void SetupThread(LibeventThread *thread);	

		//子线程的入门函数
		void WorkerLibevent(void *arg);

		//（主线程收到请求后），对应子线程的处理函数
		static void ThreadProcess(int fd, short which, void *arg);

		//被libevent回调的各个静态函数
		static void ListenerEventCb(evconnlistener *listener, evutil_socket_t fd, sockaddr *sa, int socklen, void *user_data);
		static void ReadEventCb(struct bufferevent *bev, void *data);
		static void WriteEventCb(struct bufferevent *bev, void *data); 
		static void CloseEventCb(struct bufferevent *bev, short events, void *data);

		//监听线程
		static void TcpServerStart(void *arg);

	protected:
		//这五个虚函数，一般是要被子类继承，并在其中处理具体业务的
		//新建连接成功后，会调用该函数
		virtual void ConnectionEvent(Conn *conn) { }

		//读取完数据后，会调用该函数
		virtual void ReadEvent(Conn *conn) { }

		//发送完成功后，会调用该函数（因为串包的问题，所以并不是每次发送完数据都会被调用）
		virtual void WriteEvent(Conn *conn) { }

		//断开连接（客户自动断开或异常断开）后，会调用该函数
		virtual void CloseEvent(Conn *conn, short events) { }

		//发生致命错误（如果创建子线程失败等）后，会调用该函数
		//该函数的默认操作是输出错误提示，终止程序
		virtual void ErrorQuit(const char *str);

		//检查该IP连接是否已经存在
		virtual void CloseExistConnection(uint32_t nClientIp) { }



	public:
		TcpServer(int count);
		~TcpServer();

		//设置监听的端口号，如果不需要监听，请将其设置为EXIT_CODE
		void SetPort(int port)
		{ m_Port = port; }

		//获取端口号
		int GetPort()
		{ return m_Port; }

		//开始事件循环
		bool StartRun();

		//在tv时间里结束事件循环
		//否tv为空，则立即停止
		void StopRun(timeval *tv);

		//添加和删除信号处理事件
		//sig是信号，ptr为要回调的函数
		bool AddSignalEvent(int sig, void (*ptr)(int, short, void*));
		bool DeleteSignalEvent(int sig);

		//添加和删除定时事件
		//ptr为要回调的函数，tv是间隔时间，once决定是否只执行一次
		event *AddTimerEvent(void(*ptr)(int, short, void*), timeval tv, bool once);
		bool DeleteTImerEvent(event *ev);

	};

TcpServer.cpp

TcpServer::TcpServer(int count)
	{
	#ifdef WIN32
		evthread_use_windows_threads();//win上设置
	#else
		evthread_use_pthreads();    //unix上设置
	#endif

		//初始化各项数据
		m_ThreadCount = count;
		m_Port = -1;
		m_MainBase = new LibeventThread;
		m_Threads = new LibeventThread[m_ThreadCount];

		m_MainBase->base = event_base_new();

		//初始化各个子线程的结构体
		for(int i = 0; i < m_ThreadCount; i++)
		{
			SetupThread(&m_Threads[i]);
		}
	}

	TcpServer::~TcpServer()
	{
		//停止事件循环（如果事件循环没开始，则没效果）
		StopRun(NULL);

		//释放内存
		event_base_free(m_MainBase->base);
		for(int i=0; i<m_ThreadCount; i++)
		{
			event_base_free(m_Threads[i].base);
		}		

		delete m_MainBase;
		delete [] m_Threads;
	}

	void TcpServer::ErrorQuit(const char *str)
	{
		//输出错误信息  
	}


	void TcpServer::SetupThread(LibeventThread *me)
	{
	#ifdef WIN32
		evthread_use_windows_threads();//win上设置
	#else
		evthread_use_pthreads();    //unix上设置
	#endif
		//建立libevent事件处理机制
		me->tcpConnect = this;
		me->base = event_base_new();
		if( NULL == me->base )
		{
			LOG("TcpServer::SetupThread event_base_new failed!")
			return;
		}

		evthread_make_base_notifiable(me->base);
		//在主线程和子线程之间建立管道
		evutil_socket_t fds[2] = {-1, -1};

	#ifdef WIN32
		if (evutil_socketpair(AF_INET, SOCK_STREAM, 0, fds) < 0)
		{
			LOG("TcpServer::SetupThread evutil_socketpair failed!")
			return;
		}
	#else
		if (evutil_socketpair(AF_UNIX, SOCK_STREAM, 0, fds) < 0)
		{
			LOG("TcpServer::SetupThread evutil_socketpair failed!")
			return;
		}
	#endif

		LOG("TcpServer::SetupThread notifySendFd = " << fds[0] << ", notifyReceiveFd = " << fds[1])

		me->notifySendFd = fds[0];
		me->notifyReceiveFd = fds[1]; 

		//让子线程的状态机监听管道
		event_set(&me->notifyEvent, me->notifyReceiveFd, EV_READ | EV_PERSIST, ThreadProcess, me);
		event_base_set(me->base, &me->notifyEvent);
		if (event_add(&me->notifyEvent, 0) == -1)
		{
			LOG("TcpServer::SetupThread event_add failed!")
		}
	}

	void TcpServer::WorkerLibevent(void *arg)
	{
		//开启libevent的事件循环，准备处理业务
		LibeventThread *me = (LibeventThread*)arg;
		event_base_dispatch(me->base);
	}

	bool TcpServer::StartRun()
	{
		boost::shared_ptr<boost::thread> sessionThread;
		sessionThread.reset( new boost::thread(boost::bind(&TcpServer::TcpServerStart, this) ) );
		return true;
	}

	void TcpServer::TcpServerStart(void *arg)
	{
		TcpServer *pthis_tcpServerManager = (TcpServer *)arg;
		evconnlistener *listener;

		//如果端口号不是EXIT_CODE，就监听该端口号
		if(pthis_tcpServerManager->m_Port != EXIT_CODE)
		{
			struct sockaddr_in sin;

			memset(&sin, 0, sizeof(sin));
			sin.sin_family = AF_INET;
			sin.sin_port = htons(pthis_tcpServerManager->m_Port);

			listener = evconnlistener_new_bind(pthis_tcpServerManager->m_MainBase->base, ListenerEventCb, (void*)arg,
												LEV_OPT_REUSEABLE|LEV_OPT_CLOSE_ON_FREE|LEV_OPT_CLOSE_ON_EXEC|LEV_OPT_THREADSAFE, -1,
												(struct sockaddr*)&sin, sizeof(sin));
			if( NULL == listener )
			{
				LOG("TcpServer::StartRun evconnlistener_new_bind failed!") 
				return;
			}
		}

		//开启各个子线程
		for(int i=0; i<pthis_tcpServerManager->m_ThreadCount; i++)
		{
		   pthis_tcpServerManager->m_Threads[i].tid.reset(new boost::thread(boost::bind(&TcpServer::WorkerLibevent, pthis_tcpServerManager, (void*)&(pthis_tcpServerManager->m_Threads[i]))));
		}

		//开启主线程的事件循环
		event_base_dispatch(pthis_tcpServerManager->m_MainBase->base);

		//事件循环结果，释放监听者的内存
		if(pthis_tcpServerManager->m_Port != EXIT_CODE)
		{
			evconnlistener_free(listener);
		}

		LOG("TcpServer::StartRun evconnlistener_new_bind successed!") 
		return;
	}


	void TcpServer::StopRun(timeval *tv)
	{
		int contant = EXIT_CODE;
		//向各个子线程的管理中写入EXIT_CODE，通知它们退出
		for(int i=0; i<m_ThreadCount; i++)
		{
			write(m_Threads[i].notifySendFd, (char *)&contant, sizeof(int));
		}
		//结果主线程的事件循环
		event_base_loopexit(m_MainBase->base, tv);
	}

	void TcpServer::ListenerEventCb(struct evconnlistener *listener, 
					  evutil_socket_t fd,
					  struct sockaddr *sa, 
					  int socklen, 
					  void *user_data)
	{		
		TcpServer *server = (TcpServer*)user_data;
		struct sockaddr_in *sin = (struct sockaddr_in *)sa;

		//判断如果不在允许表则关闭连接
		uint32_t nClientIp = htonl(sin->sin_addr.s_addr);

		//判断如果该IP连接已经存在怎么关闭之前的连接，重新连接
		server->CloseExistConnection(nClientIp);

		evutil_make_socket_nonblocking(fd);
		evutil_make_socket_closeonexec(fd);

		//随机选择一个子线程，通过管道向其传递socket描述符
		int num = rand() % server->m_ThreadCount;
		int sendfd = server->m_Threads[num].notifySendFd;
		write(sendfd, (char *)&fd, sizeof(evutil_socket_t));
		LOG("TcpEventServerE::ListenerEventCb send socket " << fd << " by send pipe " << sendfd)
	}

	void TcpServer::ThreadProcess(int fd, short which, void *arg)
	{
		LOG("TcpServer::ThreadProcess receive pipe =" << fd)
		LibeventThread *me = (LibeventThread*)arg;

		//从管道中读取数据（socket的描述符或操作码）
		int pipefd = me->notifyReceiveFd;
		evutil_socket_t confd;
		read(pipefd, (char *)&confd, sizeof(evutil_socket_t));

		LOG("TcpServer::ThreadProcess thread receive socket " << confd)

		//如果操作码是EXIT_CODE，则终于事件循环
		if( EXIT_CODE == confd )
		{
			LOG("TcpServer::ThreadProcess EXIT_CODE")
			event_base_loopbreak(me->base);
			return;
		}

		//新建连接
		struct bufferevent *bev;
		bev = bufferevent_socket_new(me->base, confd, BEV_OPT_THREADSAFE | BEV_OPT_CLOSE_ON_FREE);
		if (!bev)
		{
			LOG("TcpServer::ThreadProcess bufferevent_socket_new failed!")
			event_base_loopbreak(me->base);
			return;
		}

		//将该链接放入队列
		Conn *conn = me->connectQueue.InsertConn(confd, me);
		//准备从socket中读写数据
		bufferevent_setcb(bev, ReadEventCb, WriteEventCb, CloseEventCb, conn);

		struct timeval tv;
		tv.tv_sec = LINKDOWN_TIME;
		tv.tv_usec = 0; 
		bufferevent_set_timeouts(bev, &tv, &tv);

		bufferevent_enable(bev, EV_WRITE | EV_READ);

		//调用用户自定义的连接事件处理函数
		me->tcpConnect->ConnectionEvent(conn);
	}

	void TcpServer::ReadEventCb(struct bufferevent *bev, void *data)
	{
		Conn *conn = (Conn*)data;
		conn->m_ReadBuf = bufferevent_get_input(bev);
		conn->m_WriteBuf = bufferevent_get_output(bev);

		//调用用户自定义的读取事件处理函数
		conn->m_Thread->tcpConnect->ReadEvent(conn);
	} 

	void TcpServer::WriteEventCb(struct bufferevent *bev, void *data)
	{
		Conn *conn = (Conn*)data;
		conn->m_ReadBuf = bufferevent_get_input(bev);
		conn->m_WriteBuf = bufferevent_get_output(bev);

		//调用用户自定义的写入事件处理函数
		conn->m_Thread->tcpConnect->WriteEvent(conn);
	}

	void TcpServer::CloseEventCb(struct bufferevent *bev, short events, void *data)
	{				
		Conn *conn = (Conn*)data;
		LOG("TcpServer::CloseEventCb socketId=" << conn->GetFd())
		//调用用户自定义的断开事件处理函数
		conn->m_Thread->tcpConnect->CloseEvent(conn, events);
		conn->GetThread()->connectQueue.DeleteConn(conn);

		if (bev)
		{
			bufferevent_free(bev);
		}
	}

	bool TcpServer::AddSignalEvent(int sig, void (*ptr)(int, short, void*))
	{
		//新建一个信号事件
		event *ev = evsignal_new(m_MainBase->base, sig, ptr, (void*)this);
		if (!ev || event_add(ev, NULL) < 0)
		{
			event_del(ev);
			return false;
		}

		//删除旧的信号事件（同一个信号只能有一个信号事件）
		DeleteSignalEvent(sig);
		m_SignalEvents[sig] = ev;

		return true;
	}

	bool TcpServer::DeleteSignalEvent(int sig)
	{
		map<int, event*>::iterator iter = m_SignalEvents.find(sig);
		if(iter == m_SignalEvents.end())
		{
			return false;
		}		

		event_del(iter->second);
		m_SignalEvents.erase(iter);
		return true;
	}

	event *TcpServer::AddTimerEvent(void (*ptr)(int, short, void *), 
					  timeval tv, bool once)
	{
		int flag = 0;
		if(!once)
		{
			flag = EV_PERSIST;
		}		

		//新建定时器信号事件
		struct event *ev = NULL;
		event_assign(ev, m_MainBase->base, -1, flag, ptr, (void*)this);
		if(event_add(ev, &tv) < 0)
		{
			event_del(ev);
			return NULL;
		}
		return ev;
	}

	bool TcpServer::DeleteTImerEvent(event *ev)
	{
		int res = event_del(ev);
		return (0 == res);
	}

其中Conn代表每个socket连接

Conn.h

class Conn
	{
		//此类只能由TcpServer创建, 并由ConnQueue类管理
		friend class ConnQueue;
		friend class TcpServer;

	private:
		const int m_fd;				//socket的ID
		evbuffer *m_ReadBuf;		//读数据的缓冲区
		evbuffer *m_WriteBuf;		//写数据的缓冲区
		Conn *m_Prev;				//前一个结点的指针
		Conn *m_Next;				//后一个结点的指针
		LibeventThread *m_Thread;

		Conn(int fd=0);
		~Conn();

	public:

		LibeventThread *GetThread() { return m_Thread; }
		int GetFd() { return m_fd; }

		//获取可读数据的长度
		int GetReadBufferLen()
		{ return evbuffer_get_length(m_ReadBuf); }


		//从读缓冲区中取出len个字节的数据，存入buffer中，若不够，则读出所有数据
		//返回读出数据的字节数
		int GetReadBuffer(char *buffer, int len)
		{ 
			return evbuffer_remove(m_ReadBuf, buffer, len);
		}

		//从读缓冲区中复制出len个字节的数据，存入buffer中，若不够，则复制出所有数据
		//返回复制出数据的字节数
		//执行该操作后，数据还会留在缓冲区中，buffer中的数据只是原数据的副本
		int CopyReadBuffer(char *buffer, int len)
		{ 
			return evbuffer_copyout(m_ReadBuf, buffer, len);
		}

		//获取可写数据的长度
		int GetWriteBufferLen()
		{ return evbuffer_get_length(m_WriteBuf); }


		//将数据加入写缓冲区，准备发送，不会马上发送，会粘包，设备并没有处理粘包，不能用改函数
		int AddToWriteBuffer(char *buffer, int len)
		{ 
			return write(m_fd, buffer, len);
		}

		//将读缓冲区中的数据移动到写缓冲区
		void MoveBufferData()
		{ evbuffer_add_buffer(m_WriteBuf, m_ReadBuf); }
	};

Conn.cpp

Conn::Conn(int fd) : m_fd(fd)
	{
	  m_Prev = NULL;
	  m_Next = NULL;
	}

	Conn::~Conn()
	{
	}

ConnQueue是个所有socket连接的双链表类

ConnQueue.h

//带头尾结点的双链表类，每个结点存储一个连接的数据
	class ConnQueue
	{
	private:
		Conn *m_head;
		Conn *m_tail;

	public:
		ConnQueue();
		~ConnQueue();

		Conn *InsertConn(int fd, LibeventThread *t);
		void DeleteConn(Conn *c);
	};

ConnQueue.cpp

ConnQueue::ConnQueue()
	{
		//建立头尾结点，并调整其指针
		m_head = new Conn(0);
		m_tail = new Conn(0);
		m_head->m_Prev = m_tail->m_Next = NULL;
		m_head->m_Next = m_tail;
		m_tail->m_Prev = m_head;
	}

	ConnQueue::~ConnQueue()
	{
		Conn *tcur, *tnext;
		tcur = m_head;
		//循环删除链表中的各个结点
		while( tcur != NULL )
		{
			tnext = tcur->m_Next;
			delete tcur;
			tcur = tnext;
		}
	}

	Conn *ConnQueue::InsertConn(int fd, LibeventThread *t)
	{
		Conn *c = new Conn(fd);
		c->m_Thread = t;
		Conn *next = m_head->m_Next;

		c->m_Prev = m_head;
		c->m_Next = m_head->m_Next;
		m_head->m_Next = c;
		next->m_Prev = c;
		return c;
	}

	void ConnQueue::DeleteConn(Conn *c)
	{
		c->m_Prev->m_Next = c->m_Next;
		c->m_Next->m_Prev = c->m_Prev;
		delete c;
	}

LibeventThread代表每个工作线程的线程信息

LibeventThread.h

//每个子线程的线程信息
	struct LibeventThread
	{
		boost::shared_ptr<boost::thread> tid;				//线程的ID
		struct event_base *base;	//libevent的事件处理机
		struct event notifyEvent;	//监听管理的事件机

		int notifyReceiveFd;		//管理的接收端
		int notifySendFd;			//管道的发送端

		ConnQueue connectQueue;		//socket连接的链表

		//在libevent的事件处理中要用到很多回调函数，不能使用类隐含的this指针
		//所以用这样方式将TcpServer的类指针传过去
		TcpServer *tcpConnect;	 //TcpServer类的指针

	};