基本介紹
- 外文名：ioctlsocket()
- 含義：控制套接口的模式
- 頭檔案：#include <sys/socket.h>
- 性質：函式
- 系統：Windows
- windows api：#include<winsock.h>
命令模式,注釋,兼容性,返回值,參見,使用方法,
命令模式
控制套接口的模式。
#include <sys/socket.h>
s：一個標識套接口的描述字。
cmd：對套接口s的操作命令。
argp：指向cmd命令所帶參數的指針。
注釋
本函式可用於任一狀態的任一套接口。它用於獲取與套接口相關的操作參數，而與具體協定或通訊子系統無關。支持下列命令：
FIONBIO：
允許或禁止套接口s的非阻塞模式。argp指向一個無符號長整型，如允許非阻塞模式則非零，如禁止非阻塞模式則為零。當創建一個套接口時，它就處於阻塞模式（也就是說非阻塞模式被禁止）。這與BSD套接口是一致的。WSAAsynSelect()函式將套接口自動設定為非阻塞模式。如果已對一個套接口進行了WSAAsynSelect() 操作，則任何用ioctlsocket()來把套接口]重新設定成阻塞模式的試圖將以WSAEINVAL失敗。為了把套接口重新設定成阻塞模式，應用程式必須首先用WSAAsynSelect()調用（IEvent參數置為0）來禁止WSAAsynSelect()。
FIONREAD：
確定套接口s自動讀入的數據量。argp指向一個無符號長整型，其中存有ioctlsocket()的返回值。如果s是SOCKET_STREAM類型，則FIONREAD返回在一次recv()中所接收的所有數據量。這通常與套接口中排隊的數據總量相同。如果S是SOCK_DGRAM 型，則FIONREAD返回套接口上排隊的第一個數據報大小。
SIOCATMARK：
確認是否所有的帶外數據都已被讀入。這個命令僅適用於SOCK_STREAM類型的套接口，且該套接口已被設定為可以線上接收帶外數據（SO_OOBINLINE）。如無帶外數據等待讀入，則該操作返回TRUE真。否則的話返回FALSE假，下一個recv()或recvfrom()操作將檢索“標記”前一些或所有數據。應用程式可用SIOCATMARK操作來確定是否有數據剩下。如果在“緊急”（帶外）數據[前有常規數據，則按序接收這些數據（請注意，recv()和recvfrom()操作不會在一次調用中混淆常規數據與帶外數]據）。argp指向一個BOOL型數，ioctlsocket()在其中存入返回值。
兼容性
本函式為Berkeley套接口函式ioctl()的一個子集。其中沒有與FIOASYNC等價的命令，SIOCATMARK是套接口層次支持的唯一命令。
返回值
成功後，ioctlsocket()返回0。否則的話，返回-1錯誤，應用程式可通過WSAGetLastError()獲取相應錯誤代碼。
錯誤代碼：
WSANOTINITIALISED：在使用此API之前應首先成功地調用WSAStartup()。
WSAENETDOWN：套接口實現檢測到網路子系統失效。
WSAEINVAL：cmd為非法命令，或者argp所指參數不適用於該cmd命令，或者該命令
不適用於此種類型的套接口。
WSAEINPROGRESS：一個阻塞的套接口調用正在運行中。
WSAENOTSOCK：描述字不是一個套接口。
參見
socket(), setsockopt(), getsockopt(), WSAAsyncSelect().
該命令
不適用於此種類型的套接口。
WSAEINPROGRESS：一個阻塞的套接口調用正在運行中。
WSAENOTSOCK：描述字不是一個套接口。
使用方法
下面這段代碼演示了ioctlsocket函式的使用方式
C++代碼
#include <sys/socket.h>
#include <stdio.h>
#pragma comment(lib, "Ws2_32.lib")
void main(){
//-------------------------
// Initialize Winsock
WSADATA wsaData;
int iResult;
u_long iMode = 0;
iResult = WSAStartup(MAKEWORD(2,2), &wsaData);
if (iResult != NO_ERROR)
printf("Error at WSAStartup()\n");
//-------------------------
// Create a SOCKET object.
SOCKET m_socket;
m_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
if (m_socket == INVALID_SOCKET)
{ printf("Error at socket(): %ld\n", WSAGetLastError());
WSACleanup(); return;
}
//-------------------------
// Set the socket I/O mode: In this case FIONBIO
// enables or disables the blocking mode for the
// socket based on the numerical value of iMode.
// If iMode = 0, blocking is enabled;
// If iMode != 0, non-blocking mode is enabled.
iResult = ioctlsocket(m_socket, FIONBIO, &iMode);
if (iResult != NO_ERROR)
printf("ioctlsocket failed with error: %ld\n", iResult);
}
