Функция WSASendMsg (winsock2.h)

Функция WSASendMsg отправляет данные и необязательные сведения об элементе управления из подключенных и неподключенных сокетов.

Синтаксис

int WSAAPI WSASendMsg(
  [in]  SOCKET                             Handle,
  [in]  LPWSAMSG                           lpMsg,
  [in]  DWORD                              dwFlags,
  [out] LPDWORD                            lpNumberOfBytesSent,
  [in]  LPWSAOVERLAPPED                    lpOverlapped,
  [in]  LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine
);

Параметры

[in] Handle

Дескриптор, определяющий сокет.

[in] lpMsg

Структура WSAMSG хранения структуры Posix.1g msghdr.

[in] dwFlags

Флаги, используемые для изменения поведения вызова функции WSASendMsg. Дополнительные сведения см. в разделе "Использование dwFlags" в разделе "Примечания".

[out] lpNumberOfBytesSent

Указатель на номер в байтах, отправленный этим вызовом, если операция ввода-вывода завершается немедленно.

Используйте NULL для этого параметра, если параметр lpOverlapped не NULL, чтобы избежать потенциально ошибочных результатов. Этот параметр может быть NULL только в том случае, если параметр lpOverlapped не NULL.

[in] lpOverlapped

Указатель на структуру WSAOVERLAPPED. Игнорируется для не перекрывающихся сокетов.

[in] lpCompletionRoutine

Тип: _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE

Указатель на подпрограмму завершения, вызываемую после завершения операции отправки. Игнорируется для не перекрывающихся сокетов.

Возвращаемое значение

Возвращает ноль, когда происходит успешное и немедленное завершение. При возврате нуля указанная подпрограмма завершения вызывается, когда вызывающий поток находится в состоянии оповещений.

Возвращаемое значение SOCKET_ERRORи последующий вызов WSAGetLastError, возвращающий WSA_IO_PENDING, указывает, что перекрывающаяся операция успешно инициирована; Затем выполняется указание с помощью других средств, таких как события или порты завершения.

После сбоя возвращает SOCKET_ERROR и последующий вызов WSAGetLastError возвращает значение, отличное от WSA_IO_PENDING. В следующей таблице перечислены коды ошибок.

Замечания

Функцию WSASendMsg можно использовать вместо функций WSASend и WSASendTo. Функцию WSASendMsg можно использовать только с диаграммами данных и необработанными сокетами. Дескриптор сокета в параметре должен быть открыт с типом сокета, равным SOCK_DGRAM или SOCK_RAW.

Параметр dwFlags может содержать только сочетание следующих флагов управления: MSG_DONTROUTE, MSG_PARTIALи MSG_OOB. Элемент dwFlags структуры WSAMSG, на которую указывает параметр lpMsg, игнорируется при входе и не используется для выходных данных.

Перекрывающиеся сокеты создаются с вызовом функции WSASocket с набором флагов WSA_FLAG_OVERLAPPED. Для перекрывающихся сокетов отправка данных использует перекрывающиеся операции ввода-вывода, если только lpOverlapped и lpCompletionRoutineNULL; если lpOverlapped и lpCompletionRoutineNULL, сокет обрабатывается как невернутый сокет. Указание завершения происходит с перекрывающимися сокетами; После того как буфер или буферы были использованы транспортом, активируется подпрограмма завершения или устанавливается объект события. Если операция не завершается немедленно, конечный статус завершения извлекается через подпрограмму завершения или вызывая функцию WSAGetOverlappedResult.

Для неперекрывающихся сокетов lpOverlapped и lpCompletionRoutine параметры игнорируются и WSASendMsg принимает ту же семантику блокировки, что и функция отправки: данные копируются из буфера или буферов в буфер транспорта. Если сокет неблокируется и ориентирован на поток, а в буфере транспорта недостаточно места, WSASendMsg возвращается только часть буферов приложения, которые были использованы. В отличие от этого, эта ситуация буфера в сокете блокировки приводит к блокировке WSASendMsg до тех пор, пока не будет использоваться все содержимое буфера приложения.

Если эта функция завершена перекрывающимся способом, перед возвращением из этого вызова поставщик услуг Winsock несет ответственность за запись этой структуры WSABUF. Это позволяет приложениям создавать массивы WSABUF, на которые указывает член структуры WSAMSG, на которую указывает параметр lpMsg.

Для сокетов, ориентированных на сообщения, необходимо не превышать максимальный размер сообщения базового поставщика, который можно получить, получив значение параметра сокета SO_MAX_MSG_SIZE. Если данные слишком долго передаются через базовый протокол, возвращается ошибка WSAEMSGSIZE, и данные не передаются.

В сокете IPv4 типа SOCK_DGRAM или SOCK_RAWприложение может указать локальный IP-адрес, используемый для отправки с функцией WSASendMsg. Один из объектов данных управления, передаваемых в структуре WSAMSG в функцию WSASendMsg, может содержать структуру in_pktinfo, используемую для указания локального исходного адреса IPv4 для отправки.

В сокете IPv6 типа SOCK_DGRAM или SOCK_RAWприложение может указать локальный исходный IP-адрес для отправки с функцией WSASendMsg. Один из объектов данных управления, передаваемых в структуре WSAMSG в функцию WSASendMsg, может содержать структуру in6_pktinfo, используемую для указания локального исходного адреса IPv6 для отправки.

Для сокета с двумя стеками при отправке данных с помощью функции WSASendMsg и приложение хочет указать конкретный локальный IP-адрес источника, метод обработки этого зависит от целевого IP-адреса. При отправке в адрес назначения IPv4 или ipPv4-сопоставленный адрес назначения IPv6 один из объектов данных управления, передаваемых в структуре WSAMSG, на которую указывает параметр lpMsg, должен содержать структуру in_pktinfo, содержащую локальный исходный адрес IPv4, используемый для отправки. При отправке в адрес назначения IPv6, который не является ipPv4-сопоставленным IPv6-адресом, один из объектов данных управления, переданных в структуре WSAMSG, на которую указывает параметр lpMsg, должен содержать in6_pktinfo структуру, содержащую локальный исходный адрес IPv6, используемый для отправки.

dwFlags

void CALLBACK CompletionRoutine(
  IN DWORD dwError,
  IN DWORD cbTransferred,
  IN LPWSAOVERLAPPED lpOverlapped,
  IN DWORD dwFlags
);