SIO_TCP_INITIAL_RTO控制代码

项目
06/13/2023

说明

SIO_TCP_INITIAL_RTO控制代码在套接字上配置初始重新传输超时 (RTO) 参数。

若要执行此操作，请使用以下参数调用 WSAIoctl 或 WSPIoctl 函数。

int WSAIoctl(
  (socket) s,             // descriptor identifying a socket
  SIO_TCP_INITIAL_RTO,                // dwIoControlCode
  (LPVOID) lpvInBuffer,   // pointer to a TCP_INITIAL_RTO_PARAMETERS structure
  (DWORD) cbInBuffer,    // size, in bytes, of the input buffer
  (LPVOID) lpvOutBuffer,         // pointer to output buffer
  (DWORD) cbOutBuffer,       // size of output buffer
  (LPDWORD) lpcbBytesReturned,    // number of bytes returned
  (LPWSAOVERLAPPED) lpOverlapped,   // OVERLAPPED structure
  (LPWSAOVERLAPPED_COMPLETION_ROUTINE) lpCompletionRoutine,  // completion routine
);

int WSPIoctl(
  (socket) s,             // descriptor identifying a socket
  SIO_TCP_INITIAL_RTO,                // dwIoControlCode
  (LPVOID) lpvInBuffer,   // pointer to a TCP_INITIAL_RTO_PARAMETERS structure
  (DWORD) cbInBuffer,           // size, in bytes, of the input buffer
  (LPVOID) lpvOutBuffer,         // pointer to output buffer
  (DWORD) cbOutBuffer,       // size of output buffer
  (LPDWORD) lpcbBytesReturned,    // number of bytes returned
  (LPWSAOVERLAPPED) lpOverlapped,   // OVERLAPPED structure
  (LPWSAOVERLAPPED_COMPLETION_ROUTINE) lpCompletionRoutine,  // completion routine
  (LPWSATHREADID) lpThreadId,   // a WSATHREADID structure
  (LPINT) lpErrno   // a pointer to the error code.
);

parameters

S

标识套接字的描述符。

dwIoControlCode

操作的控制代码。对此操作使用 SIO_TCP_INITIAL_RTO 。

lpvInBuffer

指向输入缓冲区的指针。此参数包含指向与套接字关联的 TCP_INITIAL_RTO_PARAMETERS 的指针。

cbInBuffer

输入缓冲区的大小（以字节为单位）。

lpvOutBuffer

指向输出缓冲区的指针。此参数未用于此操作。

cbOutBuffer

输出缓冲区的大小（以字节为单位）。该参数必须设置为零。

lpcbBytesReturned

指向变量的指针，该变量接收存储在输出缓冲区中的数据的大小（以字节为单位）。

如果输出缓冲区太小，则调用失败， WSAGetLastError 返回 WSAEINVAL， lBytesReturned 参数指向 DWORD 值零。

如果 lpOverlapped 为 NULL，则成功调用时返回的 lpcbBytesReturned 参数指向的 DWORD 值不能为零。

如果对于重叠套接字， lpOverlapped 参数不是 NULL ，则将启动无法立即完成的操作，并在以后的时间指示完成。返回的 lpcbBytesReturned 参数指向的 DWORD 值可能为零，因为在重叠操作完成之前无法确定存储的数据的大小。当操作完成时发出相应的完成方法信号时，可以检索最终完成状态。

lpvOverlapped

指向 WSAOVERLAPPED 结构的指针。

如果套接字是在不使用重叠属性的情况下创建的，则忽略 lpOverlapped 参数。

如果已使用重叠属性打开，并且 lpOverlapped 参数不是 NULL，则该操作将作为重叠 (异步) 操作执行。在这种情况下， lpOverlapped 参数必须指向有效的 WSAOVERLAPPED 结构。

对于重叠操作， WSAIoctl 或 WSPIoctl 函数将立即返回，并在操作完成时发出相应的完成方法的信号。否则，函数在操作完成或发生错误之前不会返回。

lpCompletionRoutine

类型：_In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE

指向完成操作时调用的完成例程的指针， (忽略非重叠套接字) 。

lpThreadId

指向 WSATHREADID 结构的指针，供提供程序在后续调用 WPUQueueApc 时使用。在 WPUQueueApc 函数返回之前，提供程序应存储引用的 WSATHREADID 结构 (而不是指向同一) 的指针。

注意此参数仅适用于 WSPIoctl 函数。

lpErrno

指向错误代码的指针。

注意此参数仅适用于 WSPIoctl 函数。

返回值

如果操作成功完成， WSAIoctl 或 WSPIoctl 函数将返回零。

如果操作失败或挂起， WSAIoctl 或 WSPIoctl 函数将返回 SOCKET_ERROR。若要获取扩展错误信息，请调用 WSAGetLastError。

错误代码	含义
WSA_IO_PENDING	重叠的 I/O 操作正在进行中。如果已成功启动重叠操作，并且稍后将指示完成，则返回此值。
WSA_OPERATION_ABORTED	由于发生线程退出或应用程序请求，I/O 操作已中止。如果由于套接字关闭或执行 SIO_FLUSH IOCTL 命令而取消了重叠操作，则返回此错误。
WSAEACCES	尝试以被其访问权限禁止的方式访问套接字。此错误在以下几种情况下返回：用户在本地计算机上缺少所需的管理权限，或者应用程序没有作为内置管理员 (`RunAs administrator`) 在增强的 shell 中运行。
WSAEFAULT	系统在尝试在调用中使用指针参数时检测到指针地址无效。此错误返回的 lpvInBuffer、 lpvoutBuffer、 lpvbytesReturned、 lpOverlapped 或 lpCompletionRoutine 参数未完全包含在用户地址空间的有效部分。
WSAEINPROGRESS	阻止操作当前正在执行。如果在回调正在进行时调用函数，则返回此错误。
WSAEINTR	调用 WSACancelBlockingCall 中断了阻止操作。如果阻止操作中断，则返回此错误。
WSAEINVAL	提供了无效的参数。如果 dwIoControlCode 参数不是有效的命令，或者指定的输入参数不可接受，或者命令不适用于指定的套接字类型，则返回此错误。
WSAENETDOWN	套接字操作遇到了一个已死的网络。如果网络子系统发生故障，则返回此错误。
WSAENOTSOCK	尝试对不是套接字的内容执行操作。如果描述符不是套接字，则返回此错误。
WSAEOPNOTSUPP	引用的对象类型不支持尝试的操作。如果不支持指定的 IOCTL 命令，则返回此错误。如果传输提供程序不支持 SIO_TCP_INITIAL_RTO IOCTL，也会返回此错误。