lwip中TCP和UDP的API有哪些

功能

指定應(yīng)該傳遞給所有回調(diào)函數(shù)的應(yīng)用程序的具體狀態(tài)

原型

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

參數(shù)

pcb：當(dāng)前TCP連接的控制塊

arg： 需要傳遞給回調(diào)函數(shù)的參數(shù)

返回

無(wú)

功能

建立一個(gè)新的連接標(biāo)志(pcb)

原型

struct tcp_pcb *tcp_new(void)

參數(shù)

無(wú)

返回

pcb: 正常建立了連接標(biāo)志，返回建立的pcb

NULL：新的pcb內(nèi)存不可用時(shí)

功能

綁定本地IP地址和端口號(hào)

原型

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

參數(shù)

pcb： 準(zhǔn)備綁定的連接，類似于BSD標(biāo)準(zhǔn)中的Sockets

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

port： 綁定的本地端口號(hào)。注意：千萬(wàn)不要和其它的應(yīng)用程序產(chǎn)生沖突

返回

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

ERR_USE： 指定的端口號(hào)已經(jīng)綁定了一個(gè)連接，產(chǎn)生了沖突

功能

使指定的連接開始進(jìn)入監(jiān)聽狀態(tài)

原型

struct tcp_pcb *tcp_listen (struct tcp_pcb *pcb)

參數(shù)

pcb：指定將要進(jìn)入監(jiān)聽狀態(tài)的連接

返回

pcb: 返回一個(gè)新的連接標(biāo)志pcb，它作為一個(gè)參數(shù)傳遞給將要被分派的函數(shù)。這樣做的原

因是處于監(jiān)聽狀態(tài)的連接一般只需要較小的內(nèi)存，于是函數(shù)tcp_listen()就會(huì)收回原始連接

的內(nèi)存，而重新分配一個(gè)較小內(nèi)存塊供處于監(jiān)聽狀態(tài)的連接使用。

NULL： 監(jiān)聽狀態(tài)的連接的內(nèi)存塊不可用時(shí)，返回NULL。如果這樣的話，作為參數(shù)傳遞給

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

功能

使指定的連接開始進(jìn)入監(jiān)聽狀態(tài)，但將會(huì)限制監(jiān)聽隊(duì)列中連接的數(shù)量

原型

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

參數(shù)

pcb: 指定將要進(jìn)入監(jiān)聽狀態(tài)的連接

backlog: 限制監(jiān)聽隊(duì)列中連接的數(shù)量

返回

pcb: 返回一個(gè)新的連接標(biāo)志pcb，它作為一個(gè)參數(shù)傳遞給將要被分派的函數(shù)。這樣做的原

因是處于監(jiān)聽狀態(tài)的連接一般只需要較小的內(nèi)存，于是函數(shù)tcp_listen()就會(huì)收回原始

連接的內(nèi)存，而重新分配一個(gè)較小內(nèi)存塊供處于監(jiān)聽狀態(tài)的連接使用。

NULL： 監(jiān)聽狀態(tài)的連接的內(nèi)存塊不可用時(shí)，返回NULL。如果這樣的話，作為參數(shù)傳遞

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

功能

通知LwIP一個(gè)新來(lái)的連接已經(jīng)被接收

原型

void tcp_accepted(struct tcp_pcb *pcb)

參數(shù)

pcb: 已經(jīng)被接收的連接

返回

無(wú)

功能

指定處于監(jiān)聽狀態(tài)的連接接通后將要調(diào)用的回調(diào)函數(shù)

原型

void tcp_accept(struct tcp_pcb *pcb,

err_t (* accept)(void *arg,

struct tcp_pcb *newpcb,

err_t err))

參數(shù)

pcb：指定一個(gè)處于監(jiān)聽狀態(tài)的連接

accept：指定連接接通后將要調(diào)用的回調(diào)函數(shù)

返回

無(wú)

功能

請(qǐng)求指定的連接連接到遠(yuǎn)程主機(jī)，并發(fā)送打開連接的最初的SYN段

原型

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))

參數(shù)

pcb：指定一個(gè)連接(pcb)

ipaddr： 指定連接遠(yuǎn)程主機(jī)的IP地址

port： 指定連接遠(yuǎn)程主機(jī)的端口號(hào)

connected：指定連接正確建立后調(diào)用的回調(diào)函數(shù)

返回

ERR_MEM：當(dāng)訪問(wèn)SYN段的內(nèi)存不可用時(shí)，即連接沒有成功建立

ERR_OK： 當(dāng)SYN被正確地訪問(wèn)時(shí)，即連接成功建立

功能

發(fā)送TCP數(shù)據(jù)

原型

err_t tcp_write(struct tcp_pcb *pcb,

void *dataptr,

u16_t len,

u8_t copy)

參數(shù)

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

dataptr：是一個(gè)指針，它指向準(zhǔn)備發(fā)送的數(shù)據(jù)

len： 指定要發(fā)送數(shù)據(jù)的長(zhǎng)度

copy： 這是一個(gè)邏輯變量，它為0或者1，它指定是否分配新的內(nèi)存空間，而把要發(fā)送的數(shù)

據(jù)復(fù)制進(jìn)去。如果該參數(shù)為0，則不會(huì)為發(fā)送的數(shù)據(jù)分配新的內(nèi)存空間，因而對(duì)發(fā)送

數(shù)據(jù)的訪問(wèn)只能通過(guò)指定的指針

返回

ERR_MEM：如果數(shù)據(jù)的長(zhǎng)度超過(guò)了當(dāng)前發(fā)送數(shù)據(jù)緩沖區(qū)的大小或者將要發(fā)送的段隊(duì)列的

長(zhǎng)度超過(guò)了文件lwipopts.h中定義的上限(即最大值)，則函數(shù)tcp_write()調(diào)用失

敗，返回ERR_MEM

ERR_OK：數(shù)據(jù)被正確地放入到發(fā)送隊(duì)列中，返回ERR_OK

功能

指定當(dāng)遠(yuǎn)程主機(jī)成功地接收到數(shù)據(jù)后，應(yīng)用程序調(diào)用的回調(diào)函數(shù)

原型

void tcp_sent(struct tcp_pcb *pcb,

err_t (* sent)(void *arg,

struct tcp_pcb *tpcb,

u16_t len))

參數(shù)

pcb： 指定一個(gè)與遠(yuǎn)程主機(jī)相連接的連接(pcb)

sent： 指定遠(yuǎn)程主機(jī)成功地接收到數(shù)據(jù)后調(diào)用的回調(diào)函數(shù)?！發(fā)en”作為參數(shù)傳遞給回調(diào)函數(shù)，

給出上一次已經(jīng)被確認(rèn)的發(fā)送的最大字節(jié)數(shù)。

返回

無(wú)

功能

指定當(dāng)新的數(shù)據(jù)接收到時(shí)調(diào)用的回調(diào)函數(shù)

原型

void tcp_recv (struct tcp_pcb *pcb,

err_t (* recv)(void *arg,

struct tcp_pcb *tpcb,

struct pbuf *p,

err_t err))

參數(shù)

pcb： 指定一個(gè)與遠(yuǎn)程主機(jī)相連接的連接(pcb)

recv： 指定當(dāng)新的數(shù)據(jù)接收到時(shí)調(diào)用的回調(diào)函數(shù)。該回調(diào)函數(shù)可以通過(guò)傳遞一個(gè)NULL的

pbuf結(jié)構(gòu)用來(lái)指示遠(yuǎn)程主機(jī)已經(jīng)關(guān)閉連接。如果沒有錯(cuò)誤發(fā)生，則回調(diào)函數(shù)返回

ERR_OK，并且必須釋放掉pbuf結(jié)構(gòu)。否則，如果函數(shù)的調(diào)用中發(fā)生錯(cuò)誤，那么千

萬(wàn)不要釋放該結(jié)構(gòu)，以便LwIP內(nèi)核可以保存該結(jié)構(gòu)，從而等待以后處理。

返回

無(wú)

功能

獲取接收到的數(shù)據(jù)的長(zhǎng)度

原型

void tcp_recved(struct tcp_pcb *pcb, u16_t len)

參數(shù)

pcb： 指定一個(gè)與遠(yuǎn)程主機(jī)相連接的連接(pcb)

len：獲取接收到的數(shù)據(jù)的長(zhǎng)度

返回

無(wú)

功能

指定輪詢的時(shí)間間隔以及輪詢應(yīng)用程序時(shí)應(yīng)該調(diào)用的回調(diào)函數(shù)

原型

void tcp_poll(struct tcp_pcb *pcb,

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

u8_t interval)

參數(shù)

pcb：指定一個(gè)連接(pcb)

poll： 指定輪詢應(yīng)用程序時(shí)應(yīng)該調(diào)用的回調(diào)函數(shù)

interval：指定輪詢的時(shí)間間隔。時(shí)間間隔應(yīng)該以TCP的細(xì)粒度定時(shí)器為單位，典型的設(shè)置

是每秒鐘兩次。把參數(shù)“interval”設(shè)置為10意味著應(yīng)用程序?qū)⒚?秒鐘輪詢一次。

返回

無(wú)

功能

關(guān)閉一個(gè)指定的TCP連接，調(diào)用該函數(shù)后，TCP代碼將會(huì)釋放(刪除)pcb結(jié)構(gòu)

原型

err_t tcp_close(struct tcp_pcb *pcb)

參數(shù)

pcb： 指定一個(gè)需要關(guān)閉的連接(pcb)

返回

ERR_MEM：當(dāng)需要關(guān)閉的連接沒有可用的內(nèi)存時(shí)，該函數(shù)返回ERR_MEM。如果這樣的

話，應(yīng)用程序?qū)⑼ㄟ^(guò)事先確立的回調(diào)函數(shù)或者是輪詢功能來(lái)等待及重新關(guān)閉連接

ERR_OK：連接正常關(guān)閉。

功能

中止一個(gè)指定的連接(pcb)

原型

void tcp_abort(struct tcp_pcb *pcb)

參數(shù)

pcb： 指定一個(gè)需要關(guān)閉的連接(pcb)

返回

無(wú)

功能

指定處理錯(cuò)誤的回調(diào)函數(shù)

原型

void tcp_err(struct tcp_pcb *pcb,

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

參數(shù)

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

err： 指定發(fā)送錯(cuò)誤時(shí)調(diào)用的回調(diào)函數(shù)。因?yàn)閜cb結(jié)構(gòu)可能已經(jīng)被刪除了，所以在處理錯(cuò)誤

的回調(diào)函數(shù)中pcb參數(shù)不可能傳遞進(jìn)來(lái)。

返回

無(wú)

功能

建立一個(gè)用于UDP通信的UDP控制塊（pcb)

原型

struct udp_pcb *udp_new(void)

參數(shù)

無(wú)

返回

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

功能

刪除并釋放掉一個(gè)udp_pcb

原型

void udp_remove(struct udp_pcb *pcb)

參數(shù)

pcb：指定要?jiǎng)h除的連接(pcb)

返回

無(wú)

功能

為指定的連接綁定本地IP地址和端口號(hào)

原型

err_t udp_bind(struct udp_pcb *pcb,

struct ip_addr *ipaddr,

u16_t port)

參數(shù)

pcb：指定一個(gè)連接(pcb)

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

port： 綁定的本地端口號(hào)。注意：千萬(wàn)不要和其它的應(yīng)用程序產(chǎn)生沖突

返回

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

ERR_USE： 指定的端口號(hào)已經(jīng)綁定了一個(gè)連接，產(chǎn)生了沖突

功能

將參數(shù)“pcb”指定的連接控制塊連接到遠(yuǎn)程主機(jī)

原型

err_t udp_connect(struct udp_pcb *pcb,

struct ip_addr *ipaddr,

u16_t port)

參數(shù)

pcb：指定一個(gè)連接(pcb)

ipaddr：設(shè)置連接的遠(yuǎn)程主機(jī)IP地址

port： 設(shè)置連接的遠(yuǎn)程主機(jī)端口號(hào)

返回

ERR_OK：正確連接到遠(yuǎn)程主機(jī)

其它值： LwIP的一些錯(cuò)誤代碼標(biāo)志，表示連接沒有正確建立

功能

關(guān)閉參數(shù)“pcb”指定的連接, 同函數(shù)udp_connect()作用相反

原型

void udp_disconnect(struct udp_pcb *pcb)

參數(shù)

pcb：指定要?jiǎng)h除的連接(pcb)

返回

無(wú)

功能

使用UDP協(xié)議發(fā)送pbuf p指向的數(shù)據(jù)

原型

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

參數(shù)

pcb：指定發(fā)送數(shù)據(jù)的連接(pcb)

p： 包含需要發(fā)送數(shù)據(jù)的pbuf鏈

返回

ERR_OK：數(shù)據(jù)包成功發(fā)送，沒有任何錯(cuò)誤發(fā)生

ERR_MEM：內(nèi)存不可用

ERR_RTE：不能找到到達(dá)遠(yuǎn)程主機(jī)的路由

其它值：其它的一些錯(cuò)誤碼，都表示發(fā)送了錯(cuò)誤

功能

向具有指定的IP地址和端口號(hào)遠(yuǎn)程主機(jī)發(fā)送UDP數(shù)據(jù)

原型

err_t udp_sendto(struct udp_pcb *pcb,

struct pbuf *p,

struct ip_addr *dst_ip,

u16_t dst_port)

參數(shù)

pcb：指定發(fā)送數(shù)據(jù)的連接(pcb)

p： 包含需要發(fā)送數(shù)據(jù)的pbuf鏈

dst_ip：發(fā)送數(shù)據(jù)的遠(yuǎn)程主機(jī)IP地址

dst_port：發(fā)送數(shù)據(jù)的遠(yuǎn)程主機(jī)端口號(hào)

返回

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

功能

指定一個(gè)接收到UDP數(shù)據(jù)包時(shí)被調(diào)用的回調(diào)函數(shù)

原型

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)

參數(shù)

pcb：指定一個(gè)連接(pcb)

recv： 指定數(shù)據(jù)包接收到時(shí)的回調(diào)函數(shù)

recv_arg：傳遞給回調(diào)函數(shù)的參數(shù)

返回

無(wú)