複製鏈接
請複製以下鏈接發送給好友

setsockopt

鎖定
setsockopt()函數,用於任意類型、任意狀態套接口的設置選項值。儘管在不同協議層上存在選項,但本函數僅定義了最高的“套接口”層次上的選項。
中文名
套接口設置
外文名
setsockopt

setsockopt代碼

setsockopt setsockopt
設置套接口的選項。
#include <sys/types.h>
#include <sys/socket.h>
int setsockopt(int sockfd, int level, int optname,const void *optval, socklen_t optlen);
sockfd:標識一個套接口的描述字。
level:選項定義的層次;支持SOL_SOCKET、IPPROTO_TCP、IPPROTO_IP和IPPROTO_IPV6。
optname:需設置的選項。
optval:指針,指向存放選項待設置的新值的緩衝區。
optlen:optval緩衝區長度。
linux內核中定義為:
static int setsockopt(struct socket *sock,int lvl, int opt, char __user *ov, unsigned int ol);
setsockopt- set socketoption
@sock: socketstructure
@lvl: option level
@opt: option identifie
@ov: pointer to new option value
@ol: length of option value
For stream sockets only, accepts and ignores all IPPROTO_TCP options (to ease compatibility).Returns 0 on success, errno otherwise
選項影響套接口的操作,諸如加急數據是否在普通數據流中接收,廣播數據是否可以從套接口發送等等。
有兩種套接口的選項:一種是布爾型選項,允許或禁止一種特性;另一種是整型或結構選項。允許一個布爾型選項,則將optval指向非零整形數;禁止一個選項optval指向一個等於零的整形數。對於布爾型選項,optlen應等於sizeof(int);對其他選項,optval指向包含所需選項的整形數或結構,而optlen則為整形數或結構的長度。SO_LINGER選項用於控制下述情況的行動:套接口上有排隊的待發送數據,且closesocket()調用已執行。參見closesocket()函數中關於SO_LINGER選項對closesocket()語義的影響。

setsockopt特性

應用程序通過創建一個linger結構來設置相應的操作特性:
struct linger {
int l_onoff;
int l_linger;
};
為了允許SO_LINGER,應用程序應將l_onoff設為非零,將l_linger設為零或需要的超時值(以秒為單位),然後調用setsockopt()。為了允許SO_DONTLINGER(亦即禁止SO_LINGER),l_onoff應設為零,然後調用setsockopt()。
缺省條件下,一個套接口不能與一個已在使用中的本地地址捆綁(參見bind())。但有時會需要“重用”地址。因為每一個連接都由本地地址和遠端地址的組合唯一確定,所以只要遠端地址不同,兩個套接口與一個地址捆綁並無大礙。為了通知套接口實現不要因為一個地址已被一個套接口使用就不讓它與另一個套接口捆綁,應用程序可在bind()調用前先設置SO_REUSEADDR選項。請注意僅在bind()調用時該選項才被解釋;故此無需(但也無害)將一個不會共用地址的套接口設置該選項,或者在bind()對這個或其他套接口無影響情況下設置或清除這一選項。
一個應用程序可以通過打開SO_KEEPALIVE選項,使得套接口實現在TCP連接情況下允許使用“保持活動”包。一個套接口實現並不是必需支持“保持活動”,但是如果支持的話,具體的語義將與實現有關,應遵守RFC1122“Internet主機要求-通訊層”中第4.2.3.6節的規範。如果有關連接由於“保持活動”而失效,則進行中的任何對該套接口的調用都將以WSAENETRESET錯誤返回,後續的任何調用將以WSAENOTCONN錯誤返回。
TCP_NODELAY選項禁止Nagle算法。Nagle算法通過將未確認的數據存入緩衝區直到蓄足一個包一起發送的方法,來減少主機發送的零碎小數據包的數目。但對於某些應用來説,這種算法將降低系統性能。所以TCP_NODELAY可用來將此算法關閉。應用程序編寫者只有在確切瞭解它的效果並確實需要的情況下,才設置TCP_NODELAY選項,因為設置後對網絡性能有明顯的負面影響。TCP_NODELAY是唯一使用IPPROTO_TCP層的選項,其他所有選項都使用SOL_SOCKET層。
如果設置了SO_DEBUG選項,套接口供應商被鼓勵(但不是必需)提供輸出相應的調試信息。但產生調試信息的機制以及調試信息的形式已超出本規範的討論範圍。
setsockopt()支持下列選項。其中“類型”表明optval所指數據的類型。
選項 類型 意義
SO_BINDTODEV char * 將套接字綁定到指定端口。
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返回值

若無錯誤發生,setsockopt()返回0。否則的話,返回SOCKET_ERROR錯誤,應用程序可通過WSAGetLastError()獲取相應錯誤代碼。
錯誤代碼:
WSANOTINITIALISED:在使用此API之前應首先成功地調用WSAStartup()。
WSAENETDOWN:套接口實現檢測到網絡子系統失效。
WSAEFAULT:optval不是進程地址空間中的一個有效部分。
WSAEINPROGRESS:一個阻塞的套接口調用正在運行中。
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.設置調用close(socket)後,仍可繼續重用該socket。調用close(socket)一般不會立即關閉socket,而經歷TIME_WAIT的過程。
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_SOCKET, SO_SNDTIMEO, ( char * )&nNetTimeout, sizeof( int ) );
//接收時限
setsockopt( socket, SOL_SOCKET, SO_RCVTIMEO, ( char * )&nNetTimeout, sizeof( int ) );
4.在send()的時候,返回的是實際發送出去的字節(同步)或發送到socket緩衝區的字節(異步);系統默認的狀態發送和接收一次為8688字節(約為8.5K);在實際的過程中如果發送或是接收的數據量比較大,可以設置socket緩衝區,避免send(),recv()不斷的循環收發:
// 接收緩衝區
int nRecvBufLen = 32 * 1024; //設置為32K
setsockopt( s, SOL_SOCKET, SO_RCVBUF, ( const char* )&nRecvBufLen, sizeof( int ) );
//發送緩衝區
int nSendBufLen = 32*1024; //設置為32K
setsockopt( s, SOL_SOCKET, SO_SNDBUF, ( const char* )&nSendBufLen, sizeof( int ) );
5.在發送數據的時,不執行由系統緩衝區到socket緩衝區的拷貝,以提高程序的性能:
int nZero = 0;
setsockopt( socket, SOL_SOCKET, SO_SNDBUF, ( char * )&nZero, sizeof( nZero ) );
6.在接收數據時,不執行將socket緩衝區的內容拷貝到系統緩衝區:
int nZero = 0;
setsockopt( s, SOL_SOCKET, 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()沒有完成,還有數據沒發送,而調用了close(socket),以前一般採取的措施是shutdown(s,SD_BOTH),但是數
據將會丟失。
某些具體程序要求待未發送完的數據發送出去後再關閉socket,可通過設置讓程序滿足要求:
struct linger {
u_short l_onoff;
u_short l_linger;
};
struct linger m_sLinger;
m_sLinger.l_onoff = 1; //在調用close(socket)時還有數據未發送完,允許等待
// 若m_sLinger.l_onoff=0;則調用closesocket()後強制關閉
m_sLinger.l_linger = 5; //設置等待時間為5秒
setsockopt( s, SOL_SOCKET, SO_LINGER, (const char*)&m_sLinger, sizeof(struct linger));
參見:
bind(), getsockopt(), ioctlsocket(), socket(), WSAAsyncSelect().