libuv中實現tcp服務器

時間  2021-01-28
標籤 linux 編程 api 數組 服務器 socket tcp 函數 oop code 欄目 系統網絡 简体版
原文   原文鏈接

目錄

一、說明

libuv 中實現 tcp server 的步驟和原生 socket 步驟相似，回憶一下 linux 下原生 socket 實現 tcp server 的步驟：linux

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

libuv 和原生 socket 編程相似，步驟和API與原生 socket 編程步驟相似，可是使用卻變得簡單了，到處使用回調函數使得編程變得簡單了。編程

二、libuv的tcp server

libuv 對於 tcp 消息的處理，一樣是基於 stream 的，步驟以下：api

  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() 關閉套接字；

三、API簡介

附錄是整個 tcp server 的源代碼，其中涉及到的一些 API 以下：數組

3.一、uv_tcp_init

初始化 tcp 對象服務器

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

3.二、uv_ip4_addr

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

將給定的ip地址和端口轉換成sockaddr_in結構體，原生編程的時候，設置ip和端口須要至少五行，用這個方法能夠簡化操做socket

3.三、uv_tcp_bind

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

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.四、uv_listen

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

相似 listen() ，開始監聽oop

第二個參數代表內核的排隊數，最後指定有新鏈接時的回調函數code

當有新的鏈接進來時，就會觸發 on_new_connection 回調

3.五、uv_connection_cb

uv_connection_cb 是 uv_listen 的回調函數，其聲明以下：

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

server 參數爲服務器句柄

status 表示狀態，小於0表示新鏈接有誤

3.六、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.七、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.八、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.九、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.十、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.十一、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);
}
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程