setsockopt()

簡述

設定套接口選項
#include <winsock.h>
int PASCAL FAR setsockopt( SOCKET s, int level, int optname,
const char FAR* optval, int optlen);
s:標識一個套接口的描述字。
level:選項定義的層次;目前僅支持SOL_SOCKET和IPPROTO_TCP層次。
optname:需設定的選項。
optval:指針,指向存放選項值的緩衝區
optlen:optval緩衝區的長度

注釋

setsockopt()函式用於任意類型、任意狀態套接口的設定選項值。儘管在不同協定層上存在選項,但本函式僅定義了最高的“套接口”層次上的選項。選項影響套接口的操作,諸如加急數據是否在普通數據流中接收,廣播數據是否可以從套接口傳送等等。
有兩種套接口的選項:一種是布爾型選項,允許或禁止一種特性;另一種是整形或結構選項。允許一個布爾型選項,則將optval指向非零整形數;禁止一個選項optval指向一個等於零的整形數。對於布爾型選項,optlen應等於sizeof(int);對其他選項,optval指向包含所需選項的整形數或結構,而optlen則為整形數或結構的長度。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()。
預設條件下,一個套接口不能與一個已在使用中的本地地址捆綁(參見bind())。但有時會需要“重用”地址。因為每一個連線都由本地地址和遠端地址的組合唯一確定,所以只要遠端地址不同,兩個套接口與一個地址捆綁並無大礙。為了通知WINDOWS套接口實現不要因為一個地址已被一個套接口使用就不讓它與另一個套接口捆綁,應用程式可在bind()調用前先設定SO_REUSEADDR選項。請注意僅在bind()調用時該選項才被解釋;故此無需(但也無害)將一個不會共用地址的套接口設定該選項,或者在bind()對這個或其他套接口無影響情況下設定或清除這一選項。
一個應用程式可以通過打開SO_KEEPALIVE選項,使得WINDOWS套接口實現在TCP連線情況下允許使用“保持活動”包。一個WINDOWS套接口實現並不是必需支持“保持活動”,但是如果支持的話,具體的語義將與實現有關,應遵守RFC1122“Internet主機要求-通訊層”中第4.2.3.6節的規範。如果有關連線由於“保持活動”而失效,則進行中的任何對該套接口的調用都將以WSAENETRESET錯誤返回,後續的任何調用將以WSAENOTCONN錯誤返回。
TCP_NODELAY選項禁止Nagle算法。Nagle算法通過將未確認的數據存入緩衝區直到蓄足一個包一起傳送的方法,來減少主機傳送的零碎小數據包的數目。但對於某些套用來說,這種算法將降低系統性能。所以TCP_NODELAY可用來將此算法關閉。應用程式編寫者只有在確切了解它的效果並確實需要的情況下,才設定TCP_NODELAY選項,因為設定後對網路性能有明顯的負面影響。TCP_NODELAY是唯一使用IPPROTO_TCP層的選項,其他所有選項都使用SOL_SOCKET層。
如果設定了SO_DEBUG選項,WINDOWS套接口供應商被鼓勵(但不是必需)提供輸出相應的調試信息。但產生調試信息的機制以及調試信息的形式已超出本規範的討論範圍。
setsockopt()支持下列選項。其中“類型”表明optval所指數據的類型。
選項 類型意義
SO_BROADCAST BOOL 允許套接口傳送廣播信息。
SO_DEBUG BOOL 記錄調試信息。
SO_DONTLINER BOOL 不要因為數據未傳送就阻塞關閉操作。設定本選項相當於將SO_LINGER的l_onoff元素置為零。
SO_DONTROUTE BOOL 禁止選徑;直接傳送。
SO_KEEPALIVE BOOL 傳送“保持活動”包。
SO_LINGER struct linger FAR*如關閉時有未傳送數據,則逗留。
SO_OOBINLINE BOOL 在常規數據流中接收帶外數據
SO_RCVBUF int 為接收確定緩衝區大小。
SO_REUSEADDR BOOL 允許套接口和一個已在使用中的地址捆綁(參見bind())。
SO_SNDBUF int 指定傳送緩衝區大小。
TCP_NODELAY BOOL 禁止傳送合併的Nagle算法。
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:描述字不是一個套接口。
參見:
bind(), GETSOCKOPT(), ioctlsocket(), socket(), WSAAsyncSelect().

相關詞條

相關搜尋

熱門詞條

聯絡我們