setsockopt函数全面解析
說明:這篇博客算不得是原創,是我那里切一塊這里剪一塊湊來的。
先看看MSDN標準解釋
int?setsockopt(?SOCKET?s,?int?level,?int?optname,?const?char?FAR?*optval,?int?optlen?);
Parameters
s?
[in]?Descriptor?identifying?a?socket.?
level?
[in]?Level?at?which?the?option?is?defined;?the?supported?levels?include?SOL_SOCKET?and?IPPROTO_TCP.?See?Windows?Sockets?2?Protocol-Specific?Annex?for?more?information?on?protocol-specific?levels.?
optname?
[in]?Socket?option?for?which?the?value?is?to?be?set.?
optval?
[in]?Pointer?to?the?buffer?in?which?the?value?for?the?requested?option?is?supplied.?
optlen?
[in]?Size?of?the?optval?buffer.?
Return?Values
If?no?error?occurs,?setsockopt?returns?zero.?Otherwise,?a?value?of?SOCKET_ERROR?is?returned,?and?a?specific?error?code?can?be?retrieved?by?calling?WSAGetLastError.
|   Error?code  |   Meaning  | 
|   WSANOTINITIALISED  |   A?successful?WSAStartup?call?must?occur?before?using?this?function.  | 
|   WSAENETDOWN  |   The?network?subsystem?has?failed.  | 
|   WSAEFAULT  |   optval?is?not?in?a?valid?part?of?the?process?address?space?or?optlen?parameter?is?too?small.  | 
|   WSAEINPROGRESS  |   A?blocking?Windows?Sockets?1.1?call?is?in?progress,?or?the?service?provider?is?still?processing?a?callback?function.  | 
|   WSAEINVAL  |   level?is?not?valid,?or?the?information?in?optval?is?not?valid.  | 
|   WSAENETRESET  |   Connection?has?timed?out?when?SO_KEEPALIVE?is?set.  | 
|   WSAENOPROTOOPT  |   The?option?is?unknown?or?unsupported?for?the?specified?provider?or?socket  | 
|   WSAENOTCONN  |   Connection?has?been?reset?when?SO_KEEPALIVE?is?set.  | 
|   WSAENOTSOCK  |   The?descriptor?is?not?a?socket.  | 
?
?
s:標識一個套接口的描述字。
 level:選項定義的層次;目前僅支持SOL_SOCKET和IPPROTO_TCP層次。
SOL_SOCKET:?基本套接口???
 IPPROTO_IP:?IPv4套接口???
 IPPROTO_IPV6:?IPv6套接口???
 IPPROTO_TCP:?TCP套接口
 optname:需設置的選項。
 optval:指針,指向存放選項值的緩沖區。
 optlen:optval緩沖區的長度。
setsockopt()函數用于任意類型、任意狀態套接口的設置選項值。盡管在不同協議層上存在選項,但本函數僅定義了最高的“套接口”層次上的選項。選項影響套接口的操作,諸如加急數據是否在普通數據流中接收,廣播數據是否可以從套接口發送等等。有兩種套接口的選項:一種是布爾型選項,允許或禁止一種特性;另一種是整形或結構選項。允許一個布爾型選項,則將optval指向非零整形數;禁止一個選項optval指向一個等于零的整形數。對于布爾型選項,optlen應等于sizeof(int);對其他選項,optval指向包含所需選項的整形數或結構,而optlen則為整形數或結構的長度。
第二個參數level是被設置的選項的級別,如果想要在套接字級別上設置選項,就必須把level設置為?SOL_SOCKET。?option_name指定準備設置的選項,option_name可以有哪些取值,這取決于level,以linux?2.6內核為例(在不同的平臺上,這種關系可能會有不同),在套接字級別上(SOL_SOCKET),option_name可以有以下取?值:
1.SO_DEBUG,打開或關閉調試信息。
當option_value不等于0時,打開調試信息,否則,關閉調試信息。它實際所做的工作是在sock->sk->sk_flag中置?SOCK_DBG(第10)位,或清SOCK_DBG位。
如果設置了SO_DEBUG選項,WINDOWS套接口供應商被鼓勵(但不是必需)提供輸出相應的調試信息。但產生調試信息的機制以及調試信息的形式已超出本規范的討論范圍。
?
2.SO_REUSEADDR,打開或關閉地址復用功能。
當option_value不等于0時,打開,否則,關閉。它實際所做的工作是置sock->sk->sk_reuse為1或0。
缺省條件下,一個套接口不能與一個已在使用中的本地地址捆綁(參見bind())。但有時會需要“重用”地址。因為每一個連接都由本地地址和遠端地址的組合唯一確定,所以只要遠端地址不同,兩個套接口與一個地址捆綁并無大礙。為了通知WINDOWS套接口實現不要因為一個地址已被一個套接口使用就不讓它與另一個套接口捆綁,應用程序可在bind()調用前先設置SO_REUSEADDR選項。請注意僅在bind()調用時該選項才被解釋;故此無需(但也無害)將一個不會共用地址的套接口設置該選項,或者在bind()對這個或其他套接口無影響情況下設置或清除這一選項。
?
3.SO_DONTROUTE,打開或關閉路由查找功能。禁止選徑;直接傳送。
當option_value不等于0時,打開,否則,關閉。它實際所做的工作是在sock->sk->sk_flag中置或清?SOCK_LOCALROUTE位。
?
4.SO_BROADCAST,允許或禁止發送廣播數據。
當option_value不等于0時,允許,否則,禁止。它實際所做的工作是在sock->sk->sk_flag中置或清?SOCK_BROADCAST位。
一般在發送UDP數據報的時候,希望該socket發送的數據具有廣播特性:
BOOL?bBroadcast?=?TRUE;
setsockopt(?s,?SOL_SOCKET,?SO_BROADCAST,?(?const?char*?)&bBroadcast,?sizeof(?BOOL?)?);
?
5.SO_SNDBUF,設置發送緩沖區的大小。
發送緩沖區的大小是有上下限的,其上限為256?*?(sizeof(struct?sk_buff)?+?256),下限為2048字節。該操作將sock->sk->sk_sndbuf設置為val?*?2,之所以要乘以2,是防止大數據量的發送,突然導致緩沖區溢出。最后,該操作完成后,因為對發送緩沖的大小作了改變,要檢查sleep隊列,如果有進程正在等待寫,將它們喚醒。
在send()的時候,返回的是實際發送出去的字節(同步)或發送到socket緩沖區的字節(異步);系統默認的狀態發送和接收一次為8688字節(約為8.5K);在實際的過程中如果發送或是接收的數據量比較大,
?
可以設置socket緩沖區,避免send(),recv()不斷的循環收發:
//?接收緩沖區
int?nRecvBuf?=?32?*?1024;?//設置為32K
setsockopt(?s,?SOL_SOCKET,?SO_RCVBUF,?(?const?char*?)&nRecvBuf,?sizeof(?int?)?);
//發送緩沖區
int?nSendBuf?=?32*1024;?//設置為32K
setsockopt(?s,?SOL_SOCKET,?SO_SNDBUF,?(?const?char*?)&nSendBuf,?sizeof(?int?)?);
--小例子
在發送數據的時,不執行由系統緩沖區到socket緩沖區的拷貝,以提高程序的性能:
int?nZero?=?0;
setsockopt(?socket,?SOL_S0CKET,?SO_SNDBUF,?(?char?*?)&nZero,?sizeof(?nZero?)?);
?
6.SO_RCVBUF,設置接收緩沖區的大小。
接收緩沖區大小的上下限分別是:256?*?(sizeof(struct?sk_buff)?+?256)和256字節。該操作將sock->sk->sk_rcvbuf設置為val?*?2。
--小例子
在接收數據時,不執行將socket緩沖區的內容拷貝到系統緩沖區:
int?nZero?=?0;
setsockopt(?s,?SOL_S0CKET,?SO_RCVBUF,?(?char?*?)&nZero,?sizeof(?int?)?);
?
7.SO_KEEPALIVE,套接字保活。
如果協議是TCP,并且當前的套接字狀態不是偵聽(listen)或關閉(close),那么,當option_value不是零時,啟用TCP保活定時?器,否則關閉保活定時器。對于所有協議,該操作都會根據option_value置或清?sock->sk->sk_flag中的?SOCK_KEEPOPEN位。
一個應用程序可以通過打開SO_KEEPALIVE選項,使得WINDOWS套接口實現在TCP連接情況下允許使用“保持活動”包。一個WINDOWS套接口實現并不是必需支持“保持活動”,但是如果支持的話,具體的語義將與實現有關,應遵守RFC1122“Internet主機要求-通訊層”中第4.2.3.6節的規范。如果有關連接由于“保持活動”而失效,則進行中的任何對該套接口的調用都將以WSAENETRESET錯誤返回,后續的任何調用將以WSAENOTCONN錯誤返回。
s=::socket(AF_INET,SOCK_STREAM,0); //創建TCP套接字BOOL bSet=TRUE;setsockopt(s,SOL_SOCKET,SO_KEEPALIVE,(const char*)&bSet,sizeof(BOOL));//也就是在2H內,沒有數據交互,會發送探測報文。//在我們的使用中兩個小時有時會太長,便可以通過WSAIoctl函數來設置,示例:tcp_keepalive keepin;tcp_keepalive keepout;keepin.keepaliveinterval=3*1000; //1s 每10S發送1包探測報文,發5次沒有回應,就斷開keepin.keepalivetime=2*1000; //1s 超過60S沒有數據,就發送探測包keepin.onoff=1; //啟用保活 unsigned long ulBytesReturn = 0;WSAIoctl(s,SIO_KEEPALIVE_VALS,&keepin,sizeof(keepin),&keepout,sizeof(keepout),&ulBytesReturn,NULL,NULL);8.SO_OOBINLINE,緊急數據放入普通數據流。
該操作根據option_value的值置或清sock->sk->sk_flag中的SOCK_URGINLINE位。
?
9.SO_NO_CHECK,打開或關閉校驗和。
該操作根據option_value的值,設置sock->sk->sk_no_check。
?
10.SO_PRIORITY,設置在套接字發送的所有包的協議定義優先權。Linux通過這一值來排列網絡隊列。
這個值在0到6之間(包括0和6),由option_value指定。賦給sock->sk->sk_priority。
?
11.SO_LINGER,如果選擇此選項,?close或?shutdown將等到所有套接字里排隊的消息成功發送或到達延遲時間后>才會返回.?否則,?調用將立即返回。
該選項的參數(option_value)是一個linger結構:
struct?linger?
{
int???l_onoff;????/*?延時狀態(打開/關閉)?*/
int???l_linger;????/*?延時多長時間?*/
};
如果linger.l_onoff值為0(關閉),則清?sock->sk->sk_flag中的SOCK_LINGER位;否則,置該位,并賦sk->sk_lingertime值為?linger.l_linger。
SO_LINGER選項用于控制下述情況的行動:套接口上有排隊的待發送數據,且closesocket()調用已執行。參見closesocket()函數中關于SO_LINGER選項對closesocket()語義的影響。應用程序通過創建一個linger結構來設置相應的操作特性:
struct?linger?
{
int?l_onoff;
int?l_linger;
};
為了允許SO_LINGER,應用程序應將l_onoff設為非零,將l_linger設為零或需要的超時值(以秒為單位),然后調用setsockopt()。為了允許SO_DONTLINGER(亦即禁止SO_LINGER),l_onoff應設為零,然后調用setsockopt()。
--小例子
如果在發送數據的過程中send()沒有完成,還有數據沒發送,而調用了closesocket(),以前一般采取的措施是shutdown(s,SD_BOTH),但是數據將會丟失。
某些具體程序要求待未發送完的數據發送出去后再關閉socket,可通過設置讓程序滿足要求:
struct?linger?{
u_short?l_onoff;
u_short?l_linger;
};
linger?m_sLinger;
m_sLinger.l_onoff?=?1;?//在調用closesocket()時還有數據未發送完,允許等待
//?若m_sLinger.l_onoff=0;則調用closesocket()后強制關閉
m_sLinger.l_linger?=?5;?//設置等待時間為5秒
setsockopt(?s,?SOL_SOCKET,?SO_LINGER,?(?const?char*?)&m_sLinger,?sizeof(?linger?)?);
?
12.SO_DONTLINER?
不要因為數據未發送就阻塞關閉操作。設置本選項相當于將SO_LINGER的l_onoff元素置為零。
如果要已經處于連接狀態的soket在調用closesocket()后強制關閉,不經歷TIME_WAIT的過程:
BOOL?bDontLinger?=?FALSE;
setsockopt(?s,?SOL_SOCKET,?SO_DONTLINGER,?(?const?char*?)&bDontLinger,?sizeof(?BOOL?)?);
?
13.SO_PASSCRED,允許或禁止SCM_CREDENTIALS?控制消息的接收。
該選項根據option_value的值,清或置sock->sk->sk_flag中的SOCK_PASSCRED位。
?
14.SO_TIMESTAMP,打開或關閉數據報中的時間戳接收。
該選項根據option_value的值,清或置sock->sk->sk_flag中的SOCK_RCVTSTAMP位,如果打開,則還需?設sock->sk->sk_flag中的SOCK_TIMESTAMP位,同時,將全局變量netstamp_needed加1。
?
15.SO_RCVLOWAT,設置接收數據前的緩沖區內的最小字節數。
在Linux中,緩沖區內的最小字節數是固定的,為1。即將sock->sk->sk_rcvlowat固定賦值為1。
?
16.SO_RCVTIMEO,設置接收超時時間。
該選項最終將接收超時時間賦給sock->sk->sk_rcvtimeo。
?
17.SO_SNDTIMEO,設置發送超時時間。
該選項最終將發送超時時間賦給sock->sk->sk_sndtimeo。
?
18.SO_BINDTODEVICE,將套接字綁定到一個特定的設備上。
該選項最終將設備賦給sock->sk->sk_bound_dev_if。
?
19.SO_ATTACH_FILTER和SO_DETACH_FILTER。
關于數據包過濾,它們最終會影響sk->sk_filter。
?
?
以上所介紹的都是在SOL_SOCKET層的一些套接字選項,如果超出這個范圍,?給出一些不在這一level的選項作為參數,最終會得到-?ENOPROTOOPT的返回值。但以上的分析僅限于這些選項對sock-sk的值的
?
影響,這些選項真正如何發揮作用,我們的探索道路?將漫漫其修遠。
?
TCP_NODELAY選項禁止Nagle算法。Nagle算法通過將未確認的數據存入緩沖區直到蓄足一個包一起發送的方法,來減少主機發送的零碎小數據包的數目。但對于某些應用來說,這種算法將降低系統性能。所以TCP_NODELAY可用來將此算法關閉。應用程序編寫者只有在確切了解它的效果并確實需要的情況下,才設置TCP_NODELAY選項,因為設置后對網絡性能有明顯的負面影響。TCP_NODELAY是唯一使用IPPROTO_TCP層的選項,其他所有選項都使用SOL_SOCKET層。
?
setsockopt()不支持的BSD選項有:
選項名?類型?意義
SO_ACCEPTCONN?BOOL?套接口在監聽。
SO_ERROR?int?獲取錯誤狀態并清除。
SO_RCVLOWAT?int?接收低級水印。
SO_RCVTIMEO?int?接收超時。
SO_SNDLOWAT?int?發送低級水印。
SO_SNDTIMEO?int?發送超時。
SO_TYPE?int?套接口類型。
IP_OPTIONS?在IP頭中設置選項。
?
返回值:
若無錯誤發生,setsockopt()返回0。否則的話,返回SOCKET_ERROR錯誤,應用程序可通過WSAGetLastError()獲取相應錯誤代碼。
錯誤代碼:
WSANOTINITIALISED:在使用此API之前應首先成功地調用WSAStartup()。
WSAENETDOWN:WINDOWS套接口實現檢測到網絡子系統失效。
WSAEFAULT:optval不是進程地址空間中的一個有效部分。
WSAEINPROGRESS:一個阻塞的WINDOWS套接口調用正在運行中。
WSAEINVAL:level值非法,或optval中的信息非法。
WSAENETRESET:當SO_KEEPALIVE設置后連接超時。
WSAENOPROTOOPT:未知或不支持選項。其中,SOCK_STREAM類型的套接口不支持SO_BROADCAST選項,SOCK_DGRAM類型的套接口不支持SO_DONTLINGER?、SO_KEEPALIVE、SO_LINGER和SO_OOBINLINE選項。
WSAENOTCONN:當設置SO_KEEPALIVE后連接被復位。
WSAENOTSOCK:描述字不是一個套接口。
?
setsockopt()改善程序的健壯性
下面寫出我在網絡編程中的一點心得體會,希望對大家)有幫助:
 1.?如果在已經處于?ESTABLISHED狀態下的socket(一般由端口號和標志符區分)調用closesocket(一般不會立即關閉而經歷TIME_WAIT的過程)后想繼續重用該socket:
 BOOL?bReuseaddr=TRUE;
 setsockopt(s,SOL_SOCKET?,SO_REUSEADDR,(const?char*)&bReuseaddr,sizeof(BOOL));
 2.?如果要已經處于連接狀態的soket在調用closesocket后強制關閉,不經歷TIME_WAIT的過程:
 BOOL?bDontLinger?=?FALSE;?
 setsockopt(s,SOL_SOCKET,SO_DONTLINGER,(const?char*)&bDontLinger,sizeof(BOOL));
 3.在send(),recv()過程中有時由于網絡狀況等原因,發收不能預期進行,而設置收發時限:
 int?nNetTimeout=1000;//1秒
 //發送時限
 setsockopt(socket,SOL_S0CKET,SO_SNDTIMEO,(char?*)&nNetTimeout,sizeof(int));
 //接收時限
 setsockopt(socket,SOL_S0CKET,SO_RCVTIMEO,(char?*)&nNetTimeout,sizeof(int));
 4.
在send()的時候,返回的是實際發送出去的字節(同步)或發送到socket緩沖區的字節(異步);
系統默認的緩沖區發送和接收一次為8K,在實際的過程中發送數據和接收數據量比較大,可以設置socket緩沖區,而避免了send(),recv()不斷的循環收發:
 //?接收緩沖區
 int?nRecvBuf=32*1024;//設置為32K
 setsockopt(s,SOL_SOCKET,SO_RCVBUF,(const?char*)&nRecvBuf,sizeof(int));
 //發送緩沖區
 int?nSendBuf=32*1024;//設置為32K
 setsockopt(s,SOL_SOCKET,SO_SNDBUF,(const?char*)&nSendBuf,sizeof(int));
 5.?如果在發送數據的時,希望不經歷由系統緩沖區到socket緩沖區的拷貝而影響程序的性能:
 int?nZero=0;
 setsockopt(socket,SOL_S0CKET,SO_SNDBUF,(char?*)&nZero,sizeof(nZero));
 6.同上在recv()完成上述功能(默認情況是將socket緩沖區的內容拷貝到系統緩沖區):
 int?nZero=0;
 setsockopt(socket,SOL_S0CKET,SO_RCVBUF,(char?*)&nZero,sizeof(int));
 7.一般在發送UDP數據報的時候,希望該socket發送的數據具有廣播特性:
 BOOL?bBroadcast=TRUE;?
 setsockopt(s,SOL_SOCKET,SO_BROADCAST,(const?char*)&bBroadcast,sizeof(BOOL));
 8.
在client連接服務器過程中,如果處于非阻塞模式下的socket在connect()的過程中可以設置connect()延時,直到accpet()被呼叫
(本函數設置只有在非阻塞的過程中有顯著的作用,在阻塞的函數調用中作用不大)
 BOOL?bConditionalAccept=TRUE;
 setsockopt(s,SOL_SOCKET,SO_CONDITIONAL_ACCEPT,(const?char*)&bConditionalAccept,sizeof(BOOL));
 9.如果在發送數據的過程中send()沒有完成,還有數據沒發送)而調用了closesocket(),以前我們一般采取的措施是"從容關閉"shutdown(s,SD_BOTH),但是數據是肯定丟失了,如何設置讓程序滿足具體應用的要求(即讓沒發完的數據發送出去后在關閉socket)?
 struct?linger?{
 u_short?l_onoff;
 u_short?l_linger;
 };
 linger?m_sLinger;
 m_sLinger.l_onoff=1;?//(在closesocket()調用,但是還有數據沒發送完畢的時候容許逗留)
 //?如果m_sLinger.l_onoff=0;?則功能和2.作用相同;
 m_sLinger.l_linger=5;//(容許逗留的時間為5秒)
 setsockopt(s,SOL_SOCKET,SO_LINGER,(const?char*)&m_sLinger,sizeof(linger));
 Note:
1.在設置了逗留延時,用于一個非阻塞的socket是作用不大的,最好不用;
 2.如果想要程序不經歷SO_LINGER需要設置SO_DONTLINGER,或者設置l_onoff=0;
 10.還一個用的比較少的是在SDI或者是Dialog的程序中,可以記錄socket的調試信息:
 (前不久做過這個函數的測試,調式信息可以保存,包括socket建立時候的參數,采用的具體協議,以及出錯的代碼都可以記錄下來)
 BOOL?bDebug=TRUE;
 setsockopt(s,SOL_SOCKET,SO_DEBUG,(const?char*)&bDebug,sizeof(BOOL));
總結
以上是生活随笔為你收集整理的setsockopt函数全面解析的全部內容,希望文章能夠幫你解決所遇到的問題。
                            
                        - 上一篇: VS快捷键小技巧
 - 下一篇: 详细解析SELECT模型