lwip中TCP和UDP的API有哪些

原型

void tcp_arg(struct tcp_pcb *pcb, void *arg)

參數

pcb：當前TCP連接的控制塊

arg： 需要傳遞給回調函數的參數

返回

無

原型

struct tcp_pcb *tcp_new(void)

參數

無

返回

pcb: 正常建立了連接標志，返回建立的pcb

NULL：新的pcb內存不可用時

原型

err_t tcp_bind (struct tcp_pcb *pcb, struct ip_addr *ipaddr, u16_t port)

參數

pcb： 準備綁定的連接，類似于BSD標準中的Sockets

ipaddr：綁定的IP地址。如果為IP_ADDR_ANY，則將連接綁定到所有的本地IP地址上

port： 綁定的本地端口號。注意：千萬不要和其它的應用程序產生沖突

返回

ERR_OK：正確地綁定了指定的連接

ERR_USE： 指定的端口號已經綁定了一個連接，產生了沖突

原型

struct tcp_pcb *tcp_listen (struct tcp_pcb *pcb)

參數

pcb：指定將要進入監聽狀態的連接

返回

pcb: 返回一個新的連接標志pcb，它作為一個參數傳遞給將要被分派的函數。這樣做的原

因是處于監聽狀態的連接一般只需要較小的內存，于是函數tcp_listen()就會收回原始連接

的內存，而重新分配一個較小內存塊供處于監聽狀態的連接使用。

NULL： 監聽狀態的連接的內存塊不可用時，返回NULL。如果這樣的話，作為參數傳遞給

函數tcp_listen()的pcb所占用的內存將不能夠被分配。

原型

struct tcp_pcb *tcp_listen_with_backlog(struct tcp_pcb *pcb, u8_t backlog)

參數

pcb: 指定將要進入監聽狀態的連接

backlog: 限制監聽隊列中連接的數量

返回

pcb: 返回一個新的連接標志pcb，它作為一個參數傳遞給將要被分派的函數。這樣做的原

因是處于監聽狀態的連接一般只需要較小的內存，于是函數tcp_listen()就會收回原始

連接的內存，而重新分配一個較小內存塊供處于監聽狀態的連接使用。

NULL： 監聽狀態的連接的內存塊不可用時，返回NULL。如果這樣的話，作為參數傳遞

給函數tcp_listen()的pcb所占用的內存將不能夠被分配。

原型

void tcp_accepted(struct tcp_pcb *pcb)

參數

pcb: 已經被接收的連接

返回

無

原型

void tcp_accept(struct tcp_pcb *pcb,

err_t (* accept)(void *arg,

struct tcp_pcb *newpcb,

err_t err))

參數

pcb：指定一個處于監聽狀態的連接

accept：指定連接接通后將要調用的回調函數

返回

無

原型

err_t tcp_connect(struct tcp_pcb *pcb,

struct ip_addr *ipaddr,

u16_t port,

err_t (* connected)(void *arg,

struct tcp_pcb *tpcb,

err_t err))

參數

pcb：指定一個連接(pcb)

ipaddr： 指定連接遠程主機的IP地址

port： 指定連接遠程主機的端口號

connected：指定連接正確建立后調用的回調函數

返回

ERR_MEM：當訪問SYN段的內存不可用時，即連接沒有成功建立

ERR_OK： 當SYN被正確地訪問時，即連接成功建立

原型

err_t tcp_write(struct tcp_pcb *pcb,

void *dataptr,

u16_t len,

u8_t copy)

參數

pcb：指定所要發送的連接(pcb)

dataptr：是一個指針，它指向準備發送的數據

len： 指定要發送數據的長度

copy： 這是一個邏輯變量，它為0或者1，它指定是否分配新的內存空間，而把要發送的數

據復制進去。如果該參數為0，則不會為發送的數據分配新的內存空間，因而對發送

數據的訪問只能通過指定的指針

返回

ERR_MEM：如果數據的長度超過了當前發送數據緩沖區的大小或者將要發送的段隊列的

長度超過了文件lwipopts.h中定義的上限(即最大值)，則函數tcp_write()調用失

敗，返回ERR_MEM

ERR_OK：數據被正確地放入到發送隊列中，返回ERR_OK

原型

void tcp_sent(struct tcp_pcb *pcb,

err_t (* sent)(void *arg,

struct tcp_pcb *tpcb,

u16_t len))

參數

pcb： 指定一個與遠程主機相連接的連接(pcb)

sent： 指定遠程主機成功地接收到數據后調用的回調函數?！發en”作為參數傳遞給回調函數，

給出上一次已經被確認的發送的最大字節數。

返回

無

原型

void tcp_recv (struct tcp_pcb *pcb,

err_t (* recv)(void *arg,

struct tcp_pcb *tpcb,

struct pbuf *p,

err_t err))

參數

pcb： 指定一個與遠程主機相連接的連接(pcb)

recv： 指定當新的數據接收到時調用的回調函數。該回調函數可以通過傳遞一個NULL的

pbuf結構用來指示遠程主機已經關閉連接。如果沒有錯誤發生，則回調函數返回

ERR_OK，并且必須釋放掉pbuf結構。否則，如果函數的調用中發生錯誤，那么千

萬不要釋放該結構，以便LwIP內核可以保存該結構，從而等待以后處理。

返回

無

原型

void tcp_recved(struct tcp_pcb *pcb, u16_t len)

參數

pcb： 指定一個與遠程主機相連接的連接(pcb)

len：獲取接收到的數據的長度

返回

無

原型

void tcp_poll(struct tcp_pcb *pcb,

err_t (* poll)(void *arg, struct tcp_pcb *tpcb),

u8_t interval)

參數

pcb：指定一個連接(pcb)

poll： 指定輪詢應用程序時應該調用的回調函數

interval：指定輪詢的時間間隔。時間間隔應該以TCP的細粒度定時器為單位，典型的設置

是每秒鐘兩次。把參數“interval”設置為10意味著應用程序將每5秒鐘輪詢一次。

返回

無

原型

err_t tcp_close(struct tcp_pcb *pcb)

參數

pcb： 指定一個需要關閉的連接(pcb)

返回

ERR_MEM：當需要關閉的連接沒有可用的內存時，該函數返回ERR_MEM。如果這樣的

話，應用程序將通過事先確立的回調函數或者是輪詢功能來等待及重新關閉連接

ERR_OK：連接正常關閉。

原型

void tcp_abort(struct tcp_pcb *pcb)

參數

pcb： 指定一個需要關閉的連接(pcb)

返回

無

原型

void tcp_err(struct tcp_pcb *pcb,

void (* err)(void *arg, err_t err))

參數

pcb： 指定需要處理的發送錯誤的連接(pcb)

err： 指定發送錯誤時調用的回調函數。因為pcb結構可能已經被刪除了，所以在處理錯誤

的回調函數中pcb參數不可能傳遞進來。

返回

無

原型

struct udp_pcb *udp_new(void)

參數

無

返回

udp_pcb：建立的UDP連接的控制塊(pcb)

原型

void udp_remove(struct udp_pcb *pcb)

參數

pcb：指定要刪除的連接(pcb)

返回

無

原型

err_t udp_bind(struct udp_pcb *pcb,

struct ip_addr *ipaddr,

u16_t port)

參數

pcb：指定一個連接(pcb)

ipaddr：綁定的本地IP地址。如果為IP_ADDR_ANY，則將連接綁定到所有的本地IP地址上

port： 綁定的本地端口號。注意：千萬不要和其它的應用程序產生沖突

返回

ERR_OK：正確地綁定了指定的連接

ERR_USE： 指定的端口號已經綁定了一個連接，產生了沖突

原型

err_t udp_connect(struct udp_pcb *pcb,

struct ip_addr *ipaddr,

u16_t port)

參數

pcb：指定一個連接(pcb)

ipaddr：設置連接的遠程主機IP地址

port： 設置連接的遠程主機端口號

返回

ERR_OK：正確連接到遠程主機

其它值： LwIP的一些錯誤代碼標志，表示連接沒有正確建立

原型

void udp_disconnect(struct udp_pcb *pcb)

參數

pcb：指定要刪除的連接(pcb)

返回

無

原型

err_t udp_send(struct udp_pcb *pcb, struct pbuf *p)

參數

pcb：指定發送數據的連接(pcb)

p： 包含需要發送數據的pbuf鏈

返回

ERR_OK：數據包成功發送，沒有任何錯誤發生

ERR_MEM：內存不可用

ERR_RTE：不能找到到達遠程主機的路由

其它值：其它的一些錯誤碼，都表示發送了錯誤

原型

err_t udp_sendto(struct udp_pcb *pcb,

struct pbuf *p,

struct ip_addr *dst_ip,

u16_t dst_port)

參數

pcb：指定發送數據的連接(pcb)

p： 包含需要發送數據的pbuf鏈

dst_ip：發送數據的遠程主機IP地址

dst_port：發送數據的遠程主機端口號

返回

同函數udp_send()的返回值一樣

原型

void udp_recv(struct udp_pcb *pcb,

void (* recv)(void *arg,

struct udp_pcb *upcb,

struct pbuf *p,

struct ip_addr *addr,

u16_t port),

void *recv_arg)

參數

pcb：指定一個連接(pcb)

recv： 指定數據包接收到時的回調函數

recv_arg：傳遞給回調函數的參數

返回

無