利用ACL庫快速建立你的網絡程序--ACL_VSTREAM 流的使用

一、概述
    操做系統在API層爲咱們提供了進行網絡通信的庫(一組socket函數庫),但使用起來未免複雜,並且極易出錯,雖然這些socket庫最初起源於 BSD系統,各個操做系統廠商都提供了自身平臺的接口實現,但這些接口在不一樣OS上又略有差異,因此當你想寫一個跨平臺的網絡通訊程序時,工做量仍是有的,而且如不知曉各個平臺下的差別也極易出錯。
    本節向你介紹了怎樣使用ACL庫中的數據流(ACL_VSTREAM)來快速搭建你的網絡通訊程序;另外,ACL_VSTREAM 不只是跨平臺的,並且既可用於網絡通訊流,又可用於文件流,本節僅介紹網絡流的例子。
二、網絡通訊函數接口說明
2.1)服務端接口git

/**
 * 監聽某個地址(對於UNIX,還能夠監聽域套接字)
 * @param addr {const char*} 監聽地址
 *  如:127.0.0.1:80, 或域套接字, 如:/tmp/test.sock
 * @param qlen {int} 監聽隊列的長度
 * @return {ACL_VSTREAM*} 監聽流指針
 */
ACL_API ACL_VSTREAM *acl_vstream_listen(const char *addr, int qlen);

/**
 * 從監聽流中接收一個客戶端鏈接流
 * @param listen_stream {ACL_VSTREAM*} 監聽流
 * @param ipbuf {char*} 若是不爲空則用來存儲客戶端的IP地址
 * @param bsize {int} 若是 ipbuf 不爲空,則表示 ipbuf 的空間大小
 * @return {ACL_VSTREAM*} 若是不爲空則表示新接收的客戶端流
 */
ACL_API ACL_VSTREAM *acl_vstream_accept(ACL_VSTREAM *listen_stream,
                   char *ipbuf, int bsize);

 

2.二、客戶端接口github

/**
 * 遠程鏈接服務器
 * @param addr {const char*} 服務器地址,格式如:127.0.0.1,
 *  或 域套接地址:/tmp/test.sock
 * @param block_mode {int} 阻塞鏈接仍是非阻塞鏈接,ACL_BLOCKING, ACL_NON_BLOCKING
 * @param connect_timeout {int} 鏈接超時時間(秒)
 * @param rw_timeout {int} 鏈接流成功後的讀寫超時時間,單位爲秒
 * @param rw_bufsize {int} 鏈接流成功後的緩衝區大小
 * @return {ACL_VSTREAM*} 若是不爲空,則表示鏈接成功後的數據流
 */
ACL_API ACL_VSTREAM *acl_vstream_connect(const char *addr, int block_mode,
                     int connect_timeout, int rw_timeout, int rw_bufsize);

 

2.三、讀寫過程接口編程

 

/**
 * 從數據流中一次性讀取 n 個數據, 該 n 有可能會小於用戶所須要的 maxlen
 * @param stream {ACL_VSTREAM*} 數據流
 * @param vptr {void*} 用戶的數據緩衝區指針地址
 * @param maxlen {size_t} vptr 數據緩衝區的空間大小
 * @return ret {int}, ret == ACL_VSTREAM_EOF: 表示出錯, 應該關閉本地數據流,
 *  ret > 0:  表示讀到了 ret 個字節的數據
 *  注: 若是緩衝區內有數據, 則直接把緩衝區內的數據複製到用戶的緩衝區而後直接返回;
 *     若是緩衝區內無數據, 則須要調用系統讀操做(有可能會阻塞在系統讀操做上), 該
 *     次調用返回後則把讀到數據複製到用戶緩衝區返回.
 *     在這兩種狀況下都不能保證讀到的字節數等於所要求的字節數, 若想讀到所要求的
 *     字節後才返回則請調用 vstream_loop_readn() 函數.
 */
ACL_API int acl_vstream_read(ACL_VSTREAM *stream, void *vptr, size_t maxlen);

/**
 * 從數據流中讀取一行數據, 直到讀到  "\n" 或讀結束爲止, 正常狀況下包括 "\n"
 * @param stream {ACL_VSTREAM*} 數據流
 * @param vptr {void*} 用戶所給的內存緩衝區指針
 * @param maxlen {size_t} vptr 緩衝區的大小
 * @return  ret {int}, ret == ACL_VSTREAM_EOF:  讀出錯或對方關閉了鏈接,
 *  應該關閉本地數據流; n > 0:  讀到 了 n 個字節的數據, 若是該 n 個數據
 *  的最後一個非 0 字符爲 "\n" 代表讀到了一個完整的行, 不然代表讀到了 n
 *  個數據但對方未發送 "\n" 就關閉了鏈接; 還能夠經過檢查
 *  (stream->flag & ACL_VSTREAM_FLAG_TAGYES)
 *  不等於 0 來判斷是否讀到了 "\n", 若是非 0 則表示讀到了 "\n".
 */
ACL_API int acl_vstream_gets(ACL_VSTREAM *stream, void *vptr, size_t maxlen);

/**
 * 循環向數據流中寫 dlen 個字節的數據直至寫完或出錯爲止
 * @param stream {ACL_VSTREAM*} 數據流
 * @param vptr {const char*} 數據區指針地址
 * @param dlen {size_t} 待寫的數據區數據長度
 * @return ret {int}, ret == ACL_VSTREAM_EOF: 表示寫出錯, 應該關閉本地數據流,
 *  ret > 0:  表示成功寫了 dlen 個字節的數據
 */
ACL_API int acl_vstream_writen(ACL_VSTREAM *stream, const void *vptr, size_t dlen);

/**
 * 帶格式的流輸出, 相似於 fprintf()
 * @param stream {ACL_VSTREAM*} 數據流
 * @param fmt {const char*} 數據格式
 * @return ret {int}, ret == ACL_VSTREAM_EOF: 表示寫出錯, 應該關閉本地數據流,
 *  ret > 0:  表示成功寫了 dlen 個字節的數據
 */
ACL_API int acl_vstream_fprintf(ACL_VSTREAM *stream, const char *fmt, ...);

 

2.三、流關閉接口服務器

/**
 * 釋放一個數據流的內存空間並關閉其所攜帶的 socket 描述符
 * @param stream {ACL_VSTREAM*} 數據流
 */
ACL_API int acl_vstream_close(ACL_VSTREAM *stream);

 


三、網絡通訊實例
3.1 一個簡單的服務器程序網絡

#include "lib_acl.h"  /* 先包含ACL庫頭文件 */
#include <stdio.h>
#include <stdlib.h>

static void echo_client(ACL_VSTREAM *client)
{
    char  buf[1024];
    int   n;

    /* 設置客戶端流的讀超時時間爲30秒 */
    ACL_VSTREAM_SET_RWTIMO(client, 30);

    /* 循環讀客戶端的數據,直到其關閉或出錯或超時 */
    while (1) {
        /* 等待讀客戶端發來的數據 */
        n = acl_vstream_read(client, buf, sizeof(buf));
        if (n == ACL_VSTREAM_EOF)
            break;
        /* 將讀到的數據寫回至客戶端流 */
        if (acl_vstream_writen(client, buf, n) == ACL_VSTREAM_EOF)
            break;
    }

    /* 關閉客戶端流 */
    acl_vstream_close(client);
}

static void run(const char *addr)
{
    const char *myname = "run";
    ACL_VSTREAM *sstream;
    char  ebuf[256];

    /* 監聽一個本地地址 */
    sstream = acl_vstream_listen(addr, 128);
    if (sstream == NULL) {
        printf("%s(%d): listen on %s error(%s)\r\n",
            myname, __LINE__, addr,
            acl_last_strerror(ebuf, sizeof(ebuf)));
        return;
    }

    printf("%s: listen %s ok\r\n", myname, addr);
    while (1) {
        /* 等待接受客戶端的鏈接 */
        client = acl_vstream_accept(sstream, NULL, 0);
        if (client == NULL) {
            printf("%s(%d): accept error(%s)\r\n",
                myname, __LINE__,
                acl_last_strerror(ebuf, sizeof(ebuf)));
            return;
        }
        printf("accept one\r\n");
        /* 得到一個客戶端鏈接流 */
        /* 開始處理該客戶端鏈接流 */
        echo_client(client);
    }
}

static void init(void)
{
    acl_init();  /* 初始化ACL庫 */
}

static void usage(const char *procname)
{
    printf("usage: %s listen_addr\r\n", procname);
    printf("example: %s 127.0.0.1:8081\r\n", procname);
}

int main(int argc, char *argv[])
{
     if (argc != 2) {
         usage(argv[0]);
         return (0);
     }

     init();
     run(argv[1]);
     return (0);
}

 


    由上能夠看出,建立一個服務器程序是多麼的簡單,固然,這是一個阻塞式線程的服務器程序,若是你要想提升併發度,能夠在線程裏處理來自客戶端的鏈接。

3.二、一個簡單的客戶端程序併發

#include "lib_acl.h"
#include <stdio.h>
#include <stdlib.h>

static void run(const char *addr)
{
    const char *myname = "run";
    ACL_VSTREAM *client;
    char  ebuf[256], buf[1024];
    int   n, cnt = 0;

    /* 鏈接遠程服務器,採用阻塞模式鏈接,鏈接超時爲10秒,
     * 流的讀超時時間爲20秒,流的緩衝區大小爲1024字節
     */
    client = acl_vstream_connect(addr, ACL_BLOCKING, 10, 20, 1024);
    if (client == NULL) {
        printf("%s(%d): connect addr %s error(%s)\r\n",
            myname, __LINE__, addr,
            acl_last_strerror(ebuf, sizeof(ebuf)));
        return;
    }

    printf("%s: connect %s ok\r\n", myname, addr);
    while (1) {
        /* 向服務器發送一行數據 */
        n = acl_vstream_fprintf(client, ">>hi, I'm coming in...(%d)\r\n", ++cnt);
        if (n == ACL_VSTREAM_EOF)
            break;

        /* 從服務器讀取一行數據 */
        n = acl_vstream_gets(client, buf, sizeof(buf));
        if (n == ACL_VSTREAM_EOF)
            break;

        /* 最多循環5次 */
        if (cnt >= 5)
            break;

        /* 休息一下 */
        sleep(1);
    }
    /* 關閉流 */
    acl_vstream_close(client);
}

static void init(void)
{
    acl_init();  /* 初始化ACL庫 */
}

static void usage(const char *procname)
{
    printf("usage: %s server_addr\r\n", procname);
    printf("example: %s 127.0.0.1:8081\r\n", procname);
}

int main(int argc, char *argv[])
{
    if (argc != 2) {
        usage(argv[0]);
        return (0);
    }

    init();
    run(argv[1]);
    return (0);
}

 

    嗯,看來建立網絡客戶端程序原來也這麼簡單。

四、小結
    由以上例子能夠看出,ACL庫屏蔽底層SOCKET的細節操做,使網絡編程變得簡單,使使用者能夠專心於其應用,而不是拘泥於SOCKET操做上。
    固然,若要徹底編譯經過,別忘了還須要包含ACL庫的二進制版本 lib_acl.a (Unix) 或 lib_acl_vc2003.lib(Windows)。
   我的微博:http://weibo.com/zsxxsz
   acl 庫的下載地址:https://sourceforge.net/projects/acl/socket

   svn:svn checkout svn://svn.code.sf.net/p/acl/code/trunk acl-codesvn

   github:https://github.com/zhengshuxin/acl函數

   QQ 羣:242722074高併發

相關文章
相關標籤/搜索