Lwip Raw/Callback TCP服务端

参考：lwip\contrib\apps\tcpecho_raw\tcpecho_raw.c
代码如下，这里是TCP echo 的Server端：

#include "lwip/opt.h"
#include "lwip/debug.h"
#include "lwip/stats.h"
#include "lwip/tcp.h"
#include "tcpecho_raw.h"

#if LWIP_TCP && LWIP_CALLBACK_API
static struct tcp_pcb *tcpecho_raw_pcb;

enum tcpecho_raw_states
{
  ES_NONE = 0,
  ES_ACCEPTED,
  ES_RECEIVED,
  ES_CLOSING
};

struct tcpecho_raw_state
{
  u8_t state;
  u8_t retries;
  struct tcp_pcb *pcb;
  /* pbuf (chain) to recycle */
  struct pbuf *p;
};

static void
tcpecho_raw_free(struct tcpecho_raw_state *es)
{
  if (es != NULL) {
    if (es->p) {
      /* free the buffer chain if present */
      pbuf_free(es->p);
    }

    mem_free(es);
  }
}

static void
tcpecho_raw_close(struct tcp_pcb *tpcb, struct tcpecho_raw_state *es)
{
  tcp_arg(tpcb, NULL);
  tcp_sent(tpcb, NULL);
  tcp_recv(tpcb, NULL);
  tcp_err(tpcb, NULL);
  tcp_poll(tpcb, NULL, 0);

  tcpecho_raw_free(es);

  tcp_close(tpcb);
}

static void
tcpecho_raw_send(struct tcp_pcb *tpcb, struct tcpecho_raw_state *es)
{
  struct pbuf *ptr;
  err_t wr_err = ERR_OK;

  while ((wr_err == ERR_OK) &&
         (es->p != NULL) &&
         (es->p->len <= tcp_sndbuf(tpcb))) {
    ptr = es->p;

    /* enqueue data for transmission */
    wr_err = tcp_write(tpcb, ptr->payload, ptr->len, 1);
    if (wr_err == ERR_OK) {
      u16_t plen;

      plen = ptr->len;
      /* continue with next pbuf in chain (if any) */
      es->p = ptr->next;
      if(es->p != NULL) {
        /* new reference! */
        pbuf_ref(es->p);
      }
      /* chop first pbuf from chain */
      pbuf_free(ptr);
      /* we can read more data now */
      tcp_recved(tpcb, plen);
    } else if(wr_err == ERR_MEM) {
      /* we are low on memory, try later / harder, defer to poll */
      es->p = ptr;
    } else {
      /* other problem ?? */
    }
  }
}

static void
tcpecho_raw_error(void *arg, err_t err)
{
  struct tcpecho_raw_state *es;

  LWIP_UNUSED_ARG(err);

  es = (struct tcpecho_raw_state *)arg;

  tcpecho_raw_free(es);
}

static err_t
tcpecho_raw_poll(void *arg, struct tcp_pcb *tpcb)
{
  err_t ret_err;
  struct tcpecho_raw_state *es;

  es = (struct tcpecho_raw_state *)arg;
  if (es != NULL) {
    if (es->p != NULL) {
      /* there is a remaining pbuf (chain)  */
      tcpecho_raw_send(tpcb, es);
    } else {
      /* no remaining pbuf (chain)  */
      if(es->state == ES_CLOSING) {
        tcpecho_raw_close(tpcb, es);
      }
    }
    ret_err = ERR_OK;
  } else {
    /* nothing to be done */
    tcp_abort(tpcb);
    ret_err = ERR_ABRT;
  }
  return ret_err;
}

static err_t
tcpecho_raw_sent(void *arg, struct tcp_pcb *tpcb, u16_t len)
{
  struct tcpecho_raw_state *es;

  LWIP_UNUSED_ARG(len);

  es = (struct tcpecho_raw_state *)arg;
  es->retries = 0;

  if(es->p != NULL) {
    /* still got pbufs to send */
    tcp_sent(tpcb, tcpecho_raw_sent);
    tcpecho_raw_send(tpcb, es);
  } else {
    /* no more pbufs to send */
    if(es->state == ES_CLOSING) {
      tcpecho_raw_close(tpcb, es);
    }
  }
  return ERR_OK;
}

static err_t
tcpecho_raw_recv(void *arg, struct tcp_pcb *tpcb, struct pbuf *p, err_t err)
{
  struct tcpecho_raw_state *es;
  err_t ret_err;

  LWIP_ASSERT("arg != NULL",arg != NULL);
  es = (struct tcpecho_raw_state *)arg;
  if (p == NULL) {
    /* remote host closed connection */
    es->state = ES_CLOSING;
    if(es->p == NULL) {
      /* we're done sending, close it */
      tcpecho_raw_close(tpcb, es);
    } else {
      /* we're not done yet */
      tcpecho_raw_send(tpcb, es);
    }
    ret_err = ERR_OK;
  } else if(err != ERR_OK) {
    /* cleanup, for unknown reason */
    LWIP_ASSERT("no pbuf expected here", p == NULL);
    ret_err = err;
  }
  else if(es->state == ES_ACCEPTED) {
    /* first data chunk in p->payload */
    es->state = ES_RECEIVED;
    /* store reference to incoming pbuf (chain) */
    es->p = p;
    tcpecho_raw_send(tpcb, es);
    ret_err = ERR_OK;
  } else if (es->state == ES_RECEIVED) {
    /* read some more data */
    if(es->p == NULL) {
      es->p = p;
      tcpecho_raw_send(tpcb, es);
    } else {
      struct pbuf *ptr;

      /* chain pbufs to the end of what we recv'ed previously  */
      ptr = es->p;
      pbuf_cat(ptr,p);
    }
    ret_err = ERR_OK;
  } else {
    /* unknown es->state, trash data  */
    tcp_recved(tpcb, p->tot_len);
    pbuf_free(p);
    ret_err = ERR_OK;
  }
  return ret_err;
}

static err_t
tcpecho_raw_accept(void *arg, struct tcp_pcb *newpcb, err_t err)
{
  err_t ret_err;
  struct tcpecho_raw_state *es;

  LWIP_UNUSED_ARG(arg);
  if ((err != ERR_OK) || (newpcb == NULL)) {
    return ERR_VAL;
  }

  /* Unless this pcb should have NORMAL priority, set its priority now.
     When running out of pcbs, low priority pcbs can be aborted to create
     new pcbs of higher priority. */
  tcp_setprio(newpcb, TCP_PRIO_MIN);

  es = (struct tcpecho_raw_state *)mem_malloc(sizeof(struct tcpecho_raw_state));
  if (es != NULL) {
    es->state = ES_ACCEPTED;
    es->pcb = newpcb;
    es->retries = 0;
    es->p = NULL;
    /* pass newly allocated es to our callbacks */
    tcp_arg(newpcb, es);
    tcp_recv(newpcb, tcpecho_raw_recv);
    tcp_err(newpcb, tcpecho_raw_error);
    tcp_poll(newpcb, tcpecho_raw_poll, 0);
    tcp_sent(newpcb, tcpecho_raw_sent);
    ret_err = ERR_OK;
  } else {
    ret_err = ERR_MEM;
  }
  return ret_err;
}

void
tcpecho_raw_init(void)
{
  tcpecho_raw_pcb = tcp_new_ip_type(IPADDR_TYPE_ANY);
  if (tcpecho_raw_pcb != NULL) {
    err_t err;

    err = tcp_bind(tcpecho_raw_pcb, IP_ANY_TYPE, 7);
    if (err == ERR_OK) {
      tcpecho_raw_pcb = tcp_listen(tcpecho_raw_pcb);
      tcp_accept(tcpecho_raw_pcb, tcpecho_raw_accept);
    } else {
      /* abort? output diagnostic? */
    }
  } else {
    /* abort? output diagnostic? */
  }
}
#endif /* LWIP_TCP && LWIP_CALLBACK_API */

服务端基本流程是：

1、tcp_new_ip_type：创建一个 struct tcp_pcb 结构体。
2、tcp_bind：绑定IP和端口。
3、tcp_listen：listen函数创建了struct tcp_pcb_listen 结构体，并把tcp_new_ip_type函数创建的 tcp_pcb结构体中的元素对应拷贝，把tcp_pcb_listen 结构体添加到监听链表中，释放掉 tcp_pcb结构体。
4、tcp_accept：只是注册了tcp_pcb结构体中的 accept函数，当有客户端连接的时候，协议栈会调用 pcb->accept() 函数。
5、tcpecho_raw_accept 函数：在回调函数 tcpecho_raw_accept  中，参数 newpcb 是客户端连接后新创建的 tcp_pcb 结构体。
 	而函数功能是通过调用：tcp_arg()、tcp_recv()、tcp_err()、tcp_poll()、tcp_sent() 来注册新创建的 tcp_pcb 中的对应的 arg参数和对应的回调函数。
 	(1)、recv：当有TCP数据是回调 recv 函数。
	(2)、errf ：当出错是回调 errf 函数。
	(3)、poll ：连结后按周期执行 poll 函数。
	(4)、sent：当数据发送出去，对方接受到后，回调 sent 函数。

模块化上面创建 server 的代码:

// 首先创建一个回调函数的结构体
// sent recv poll errf 和 tcpecho_raw_accept 函数中的类型一样
typedef int (*callfn)(void *);

typedef struct TcpServerCallback {
	tcp_sent_fn sent;
	/* Function to be called when (in-sequence) data has arrived. */
	tcp_recv_fn recv;
	/* Function which is called periodically. */
	tcp_poll_fn poll;
	/* Function to be called whenever a fatal error occurs. */
	tcp_err_fn  errf;
	callfn		HvInitArg;
} TcpSerCb_t;

static err_t  Raw_TcpServer_Accept(void *arg, struct tcp_pcb *newpcb, err_t err);

// 创建server 函数， 参数分别为 ip、port、回调函数的结构体
struct tcp_pcb* Raw_Create_LwipTcpServer(const ip_addr_t *ipaddr, u16_t port, struct TcpSerCb_t *TcpCbs)
{
	struct tcp_pcb *pcb = NULL;

	if (tcpState == NULL)
		return NULL;

	pcb = tcp_new_ip_type(IPADDR_TYPE_V4);//IPADDR_TYPE_V4 || IPADDR_TYPE_V6 || IPADDR_TYPE_ANY
	if (pcb == NULL){
		return NULL;
	}
	if (ERR_OK != tcp_bind(pcb, ipaddr, port))
	{
		tcp_free(pcb);
		return NULL;
	}
	pcb = tcp_listen(pcb);
	// 这里注册 list pcb 的 arg，把 server 的回调函数结构体记录下，传给accept函数。
	tcp_arg(pcb, TcpCbs);
	tcp_accept(pcb, TcpServer_Accept);
	return pcb;
}
// accept 函数功能比较简单，客户端连接首回调 注册客户端pcb的对应回调函数
static err_t  Raw_TcpServer_Accept(void *arg, struct tcp_pcb *newpcb, err_t err)
{
	err_t  err;
	struct TcpSerCb_t* TcpCbs;
	HvTcpSer_Context * Context;
	
	if ((err != ERR_OK) || (newpcb == NULL)) {
		return ERR_VAL;
	}
	
	// 获取到 listen pcb 传入的回调函数结构体
	TcpCbs = (struct TcpSerCb_t*)arg;
	if (TcpCbs == NULL){ // report error
		return ERR_MEM;
	}
	
	// 申请tcp_pcb 结构体的 arg，该结构体根据用户需要定义
	Context = (HvTcpSer_Context *)mem_malloc(sizeof(HvTcpSer_Context));
	if (Context == NULL){
		return ERR_MEM;
	}
	// 初始化 arg 
	if (TcpCbs->HvInitArg != NULL){
		TcpCbs->HvInitArg(Context);
	} else {
		memset(Context, 0, sizeof(Context));
	}
	// 注册对应的参数和函数
	tcp_arg(newpcb, Context);
	tcp_recv(newpcb, TcpCbs->recv);
    tcp_err(newpcb,  TcpCbs->errf);
    tcp_poll(newpcb, TcpCbs->poll, 0);
    tcp_sent(newpcb, TcpCbs->sent);	
	return ERR_OK;
}

example：创建一个server

static void Raw_TcpServer_Close(struct tcp_pcb *tpcb, HvTcpSer_Context *AppContext)
{
  tcp_sent(tpcb, NULL);
  tcp_recv(tpcb, NULL);
  tcp_err(tpcb, NULL);
  tcp_poll(tpcb, NULL, 0);

  // free arg
  if (AppContext != NULL) {
	if (AppContext->p) {
		/* free the buffer chain if present */
		pbuf_free(AppContext->p);
  	}

   		mem_free(AppContext);
   }
   tcp_close(tpcb);
 }

static err_t Raw_TcpSer_Recv(void *arg, struct tcp_pcb *tpcb, struct pbuf *p, err_t err)
{
	HvTcpSer_Context *context;
	struct pbuf *ptr;
	
	context = (HvTcpSer_Context *)arg;
	
	// close
	if (NULL == p || err <= ERR_CONN ){
		Raw_TcpServer_Close(tpcb, context);
		return ERR_OK;
	}
	
	if (ERR_OK != err){
		// deal the err
		return err;
	}
	
	if (context->p != NULL){ // 
		ptr = context->p;
		pbuf_cat(ptr,p);
	}else{
		context->p = p;
	}
	// maybe you want to do something at once the data arrived
	// parse the buf
	return ERR_OK;
}

static err_t Raw_TcpSer_Poll(void *arg, struct tcp_pcb *tpcb)
{
	HvTcpSer_Context *context;
	context = (HvTcpSer_Context *)arg;
	
	// do something periodically, the period is configurable
	//Parser_Data(context);
	
	return ERR_OK;
}

static err_t Raw_TcpSer_Sent(void *arg, struct tcp_pcb *tpcb, u16_t len)
{
	// data have sent to client, let you know
	// maybe you want to do something
	return ERR_OK;
}

static void  Raw_TcpSer_Err(void *arg, err_t err)
{
	// something wrong, you should do something here
}

TcpSerCb_t Myserver = {
		.sent = Raw_TcpSer_Sent,
		.recv = Raw_TcpSer_Recv,
		.poll = Raw_TcpSer_Poll,
		.errf = Raw_TcpSer_Err
}

IP4_ADDR(&ipAddr, 192, 168, 100, 10);
if (NULL == Raw_Create_LwipTcpServer(&ipAddr, 9500, &Myserver ))
	;// error

发送数据需要调用 tcp_write 函数， 该函数并不执行发送动作，只是把数据写入发送队列中：

	err_t  tcp_write(struct tcp_pcb *pcb, const void *arg, u16_t len, u8_t apiflags);
	参数：pcb : TCP 客户端连接的控制块，tcp_write 函数就是把数据缓存到 pcb 中。
				arg : 要写入的数据地址。
				len : 要写入的数据长度。
				apiflags : 有两个值可选：TCP_WRITE_FLAG_COPY 数据会被拷贝到 lwip 内存堆栈中。
										TCP_WRITE_FLAG_MORE 数据不拷贝。

如果需要立即发送 使用tcp_write 写入数据后，调用 tcp_output， 在接收的回调函数中调用 tcp_output 无效。