функция обратного вызова LPFN_RIORECEIVE (mswsock.h)

Функция RIOReceive получает сетевые данные в подключенном зарегистрированном сокете TCP ввода-вывода или связанном зарегистрированном сокете UDP ввода-вывода для использования с зарегистрированными расширениями ввода-вывода Winsock.

Синтаксис

LPFN_RIORECEIVE LpfnRioreceive;

BOOL LpfnRioreceive(
  RIO_RQ SocketQueue,
  PRIO_BUF pData,
  ULONG DataBufferCount,
  DWORD Flags,
  PVOID RequestContext
)
{...}

Параметры

SocketQueue

Дескриптор, идентифицирующий подключенный зарегистрированный сокет TCP ввода-вывода или связанный зарегистрированный сокет UDP ввода-вывода.

pData

Описание части зарегистрированного буфера, в которой будут приниматься данные.

Этот параметр может иметь значение NULL для привязанного зарегистрированного сокета UDP ввода-вывода, если приложению не нужно получать полезные данные в датаграмме UDP.

DataBufferCount

Параметр счетчика буфера данных, указывающий, должны ли данные быть получены в буфере, на который указывает параметр pData .

Этот параметр должен иметь значение 0, если значение pData равно NULL. В противном случае этому параметру следует присвоить значение 1.

Flags

Набор флагов, которые изменяют поведение функции RIOReceive .

Параметр Flags может содержать сочетание следующих параметров, определенных в файле заголовка Mswsockdef.h :

RIO_MSG_COMMIT_ONLY

Предыдущие запросы, добавленные с флагом RIO_MSG_DEFER , будут зафиксированы.

Если флаг RIO_MSG_COMMIT_ONLY установлен, другие флаги не могут быть указаны. Если установлен флаг RIO_MSG_COMMIT_ONLY , аргументы pData и RequestContext должны иметь значение NULL, а аргумент DataBufferCount должен быть равен нулю.

Этот флаг обычно используется иногда после того, как несколько запросов были выданы с установленным флагом RIO_MSG_DEFER . Это избавляет от необходимости при использовании флага RIO_MSG_DEFER выполнять последний запрос без флага RIO_MSG_DEFER , что приводит к тому, что последний запрос выполняется гораздо медленнее, чем другие запросы.

В отличие от других вызовов функции RIOReceive , при установке флага RIO_MSG_COMMIT_ONLY вызовы функции RIOReceive не нужно сериализовать. Для одного RIO_RQ функцию RIOReceive можно вызывать с помощью RIO_MSG_COMMIT_ONLY в одном потоке при вызове функции RIOReceive в другом потоке.

RIO_MSG_DONT_NOTIFY

Запрос не должен активировать функцию RIONotify при вставке завершения запроса в очередь завершения.

RIO_MSG_DEFER

Запрос не нужно выполнять немедленно. Это приведет к вставке запроса в очередь запросов, но может вызвать или не запустить выполнение запроса.

Прием данных может быть отложен до выполнения запроса на получение RIO_RQ , переданного в параметре SocketQueue без установленного флага RIO_MSG_DEFER . Чтобы активировать выполнение для всех получаемых сообщений в очереди запросов, вызовите функцию RIOReceive или RIOReceiveEx без установленного флага RIO_MSG_DEFER .

RIO_MSG_WAITALL

Функция RIOReceive не будет завершена, пока не произойдет одно из следующих событий:

• Сегмент буфера, предоставленный вызывающим объектом в параметре pData , полностью заполнен.
• Соединение было закрыто.
• Запрос был отменен или произошла ошибка.

Этот флаг не поддерживается в сокетах UDP.

RequestContext

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

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

Если ошибка не возникает, функция RIOReceive возвращает значение TRUE. В этом случае операция получения успешно запущена, и завершение будет уже поставлено в очередь или операция успешно запущена, а завершение будет помещено в очередь позже.

Значение FALSE указывает, что функция завершилась сбоем, операция не была успешно инициирована, и индикатор завершения не будет помещен в очередь. Конкретный код ошибки можно получить, вызвав функцию WSAGetLastError .

Комментарии

Приложение может использовать функцию RIOReceive для получения сетевых данных в любой буфер, полностью содержащийся в одном зарегистрированном буфере. Элементы Offset и Length структуры RIO_BUF , на которые указывает параметр pData, определяют, где в буфере получены сетевые данные.

После вызова функции RIOReceive буфер, переданный в параметре pData , включая RIO_BUFFERID в элементе BufferIdструктуры RIO_BUF , должен оставаться действительным в течение операции получения.

Чтобы избежать состояния гонки, буфер, связанный с запросом на получение, не следует читать или записывать до завершения запроса. Сюда входит использование буфера в качестве источника для запроса на отправку или назначения для другого запроса на получение. Части зарегистрированного буфера, не связанные с каким-либо запросом на получение, не включаются в это ограничение.

Параметр Flags можно использовать для влияния на поведение вызова функции RIOReceive за пределами параметров, указанных для связанного сокета. Поведение этой функции определяется сочетанием всех параметров сокета, заданных в сокете, связанном с параметром SocketQueue, и значениями, указанными в параметре Flags .

Windows Phone 8. Эта функция поддерживается для приложений Магазина Windows Phone на Windows Phone 8 и более поздних версиях.

Windows 8.1 и Windows Server 2012 R2. Эта функция поддерживается для приложений Магазина Windows на Windows 8.1, Windows Server 2012 R2 и более поздних версиях.

Требования