c++ 如何在libuv中實現tcp服務器

1、說明

libuv 中實現 tcp server 的步驟和原生 socket 步驟類似,回憶一下 linux 下原生 socket 實現 tcp server 的步驟:

  1. 初始化 socket 環境,獲取 socket 套接字;
  2. bind() 方法綁定套接字到本地IP;
  3. listen() 方法監聽 socket,獲取新連接;
  4. accept() 方法接受客戶端連接,返回客戶端套接字;
  5. recv() 方法接受客戶端的數據;
  6. send() 方法向客戶端發送數據;
  7. closesocket() 方法關閉套接字;

libuv 和原生 socket 編程類似,步驟和API與原生 socket 編程步驟類似,但是使用卻變得簡單瞭,處處使用回調函數使得編程變得簡單瞭。

2、libuv的tcp server

libuv 對於 tcp 消息的處理,同樣是基於 stream 的,步驟如下:

  1. uv_tcp_init() 建立 tcp 句柄;
  2. uv_tcp_bind() 方法綁定ip;
  3. uv_listen() 方法監聽,有新連接時,調用回調函數;
  4. uv_accept() 方法獲取客戶端套接字;
  5. uv_read_start() 方法讀取客戶端數據;
  6. uv_write() 方法想客戶端發送數據;
  7. uv_close() 關閉套接字;

3、API簡介

附錄是整個 tcp server 的源代碼,其中涉及到的一些 API 如下:

3.1、uv_tcp_init

初始化 tcp 對象

uv_tcp_t server;
uv_tcp_init(loop, &server);//初始化tcp server對象

3.2、uv_ip4_addr

struct sockaddr_in addr;
uv_ip4_addr("0.0.0.0", DEFAULT_PORT, &addr);

將給定的ip地址和端口轉換成sockaddr_in結構體,原生編程的時候,設置ip和端口需要至少五行,用這個方法可以簡化操作

3.3、uv_tcp_bind

等同於原生API的 bind() 方法

uv_tcp_bind(&server, (const struct sockaddr *) &addr, 0);

uv_tcp_bind() 的第三個參數 flag 一般是0,如果想使用IP6,可以使用 UV_TCP_IPV6ONLY

enum uv_tcp_flags {
 /* Used with uv_tcp_bind, when an IPv6 address is used. */
 UV_TCP_IPV6ONLY = 1
};

3.4、uv_listen

uv_listen((uv_stream_t *) &server, 128, on_new_connection);

類似 listen() ,開始監聽

第二個參數表明內核的排隊數,最後指定有新連接時的回調函數

當有新的連接進來時,就會觸發 on_new_connection 回調

3.5、uv_connection_cb

uv_connection_cb 是 uv_listen 的回調函數,其聲明如下:

typedef void (*uv_connection_cb)(uv_stream_t* server, int status);

server 參數為服務器句柄

status 表示狀態,小於0表示新連接有誤

3.6、uv_accept

新連接觸發回調函數之後,按照一般流程,需要使用 accept() 方法獲取客戶端句柄,libuv 中使用 uv_accept(),其聲明如下:

int uv_accept(uv_stream_t* server, uv_stream_t* client)

在調用之前,client 參數必須被初始化

返回值 <0 表示有誤

示例:

uv_tcp_t *client = (uv_tcp_t *) malloc(sizeof(uv_tcp_t));//為tcp client申請資源
uv_tcp_init(loop, client);//初始化tcp client句柄
if (uv_accept(server, (uv_stream_t *) client) == 0) {
	do_some_thind();
}

3.7、uv_read_start

libuv 中使用 uv_read_start() 方法從傳入的 stream 中讀取數據,聲明如下:

int uv_read_start(uv_stream_t* stream, uv_alloc_cb alloc_cb, uv_read_cb read_cb)

read_cb 會被多次調用,直到數據讀完,或者主動調用 uv_read_stop() 方法停止

該函數有兩個回調函數,alloc_cb 用於為新來的數據申請空間,申請的資源需要在 read_cb 中釋放

這兩個回調的聲明如下:

typedef void (*uv_alloc_cb)(uv_handle_t* handle, size_t suggested_size, uv_buf_t* buf);
typedef void (*uv_read_cb)(uv_stream_t* stream, ssize_t nread, const uv_buf_t* buf);

示例代碼:

//負責為新來的消息申請空間
void alloc_buffer(uv_handle_t *handle, size_t suggested_size, uv_buf_t *buf) {
 buf->len = suggested_size;
 buf->base = static_cast<char *>(malloc(suggested_size));
}
/**
 * @brief: 負責處理新來的消息
 * @param: client
 * @param: nread>0表示有數據就緒,nread<0表示異常,nread是有可能為0的,但是這並不是異常或者結束
 */
void read_cb(uv_stream_t *client, ssize_t nread, const uv_buf_t *buf) {
	do_somt_thing();
 //釋放之前申請的資源
 if (buf->base != NULL) {
 free(buf->base);
 }
}

uv_read_start((uv_stream_t *) client, alloc_buffer, read_cb);

3.8、uv_buf_t 和 uv_buf_init

uv_buf_t 是libuv 中的一種特殊的數據類型,和 Redis 的 SDS 有一點相似度,聲明如下:

typedef struct uv_buf_t {
 char* base;
 size_t len;
} uv_buf_t;

uv_buf_t 可以使用 uv_buf_init 初始化

示例:

uv_buf_t uvBuf = uv_buf_init(buf->base, nread);//初始化write的uv_buf_t

3.9、uv_close

libuv 中使用 uv_close() 方法關閉句柄,聲明如下:

void uv_close(uv_handle_t* handle, uv_close_cb close_cb)

close_cb 為關閉之後的回調,聲明如下:

typedef void (*uv_close_cb)(uv_handle_t* handle);

代碼示例:

void on_close(uv_handle_t *handle) {
 if (handle != NULL)
 free(handle);
}
...
uv_close((uv_handle_t *) client, on_close);

3.10、uv_write

libuv 中使用 uv_write() 方法發送數據,聲明如下:

int uv_write(uv_write_t* req, uv_stream_t* handle, const uv_buf_t bufs[],
      unsigned int nbufs, uv_write_cb cb);

req 是需要傳遞給回調函數的數據,發送需要申請資源,並在回調函數中釋放

handle 是接受的客戶端

bufs[] 是一個 uv_buf_t 數組,可以一次添加多組數據,最終按照順序發送

nbufs 表示需要發送的數組元素個數,一般小於等於 bufs 的大小

3.11、uv_strerror

有些函數會有錯誤碼,使用 uv_strerror() 方法獲取錯誤碼對應的描述

附錄

源代碼如下:

#include <stdio.h>
#include <uv.h>
#include <stdlib.h>

uv_loop_t *loop;
#define DEFAULT_PORT 7000

//連接隊列最大長度
#define DEFAULT_BACKLOG 128

//負責為新來的消息申請空間
void alloc_buffer(uv_handle_t *handle, size_t suggested_size, uv_buf_t *buf) {
 buf->len = suggested_size;
 buf->base = static_cast<char *>(malloc(suggested_size));
}

void on_close(uv_handle_t *handle) {
 if (handle != NULL)
 free(handle);
}

void echo_write(uv_write_t *req, int status) {
 if (status) {
 fprintf(stderr, "Write error %s\n", uv_strerror(status));
 }

 free(req);
}

/**
 * @brief: 負責處理新來的消息
 * @param: client
 * @param: nread>0表示有數據就緒,nread<0表示異常,nread是有可能為0的,但是這並不是異常或者結束
 * @author: sherlock
 */
void read_cb(uv_stream_t *client, ssize_t nread, const uv_buf_t *buf) {
 if (nread > 0) {
// buf->base[nread] = 0;
 fprintf(stdout, "recv:%s\n", buf->base);
 fflush(stdout);

 uv_write_t* req = (uv_write_t*)malloc(sizeof(uv_write_t));

 uv_buf_t uvBuf = uv_buf_init(buf->base, nread);//初始化write的uv_buf_t

 //發送buffer數組,第四個參數表示數組大小
 uv_write(req, client, &uvBuf, 1, echo_write);

 return;
 } else if (nread < 0) {
 if (nread != UV_EOF) {
  fprintf(stderr, "Read error %s\n", uv_err_name(nread));
 } else {
  fprintf(stderr, "client disconnect\n");
 }
 uv_close((uv_handle_t *) client, on_close);
 }

 //釋放之前申請的資源
 if (buf->base != NULL) {
 free(buf->base);
 }
}

/**
 *
 * @param: server libuv的tcp server對象
 * @param: status 狀態,小於0表示新連接有誤
 * @author: sherlock
 */
void on_new_connection(uv_stream_t *server, int status) {
 if (status < 0) {
 fprintf(stderr, "New connection error %s\n", uv_strerror(status));
 return;
 }

 uv_tcp_t *client = (uv_tcp_t *) malloc(sizeof(uv_tcp_t));//為tcp client申請資源

 uv_tcp_init(loop, client);//初始化tcp client句柄

 //判斷accept是否成功
 if (uv_accept(server, (uv_stream_t *) client) == 0) {
 //從傳入的stream中讀取數據,read_cb會被多次調用,直到數據讀完,或者主動調用uv_read_stop方法停止
 uv_read_start((uv_stream_t *) client, alloc_buffer, read_cb);
 } else {
 uv_close((uv_handle_t *) client, NULL);
 }
}

int main(int argc, char **argv) {
 loop = uv_default_loop();

 uv_tcp_t server;
 uv_tcp_init(loop, &server);//初始化tcp server對象

 struct sockaddr_in addr;

 uv_ip4_addr("0.0.0.0", DEFAULT_PORT, &addr);//將ip和port數據填充到sockaddr_in結構體中

 uv_tcp_bind(&server, (const struct sockaddr *) &addr, 0);//bind

 int r = uv_listen((uv_stream_t * ) & server, DEFAULT_BACKLOG, on_new_connection);//listen

 if (r) {
 fprintf(stderr, "Listen error %s\n", uv_strerror(r));
 return 1;
 }

 return uv_run(loop, UV_RUN_DEFAULT);
}

以上就是c++ 如何在libuv中實現tcp服務器的詳細內容,更多關於libuv中實現tcp服務器的資料請關註WalkonNet其它相關文章!