А. Григорьев - О чём не пишут в книгах по Delphi

Перекрытым вводом-выводом управляют два последних параметра функции, но WSARecvобладает и другими дополнительными по сравнению с функцией recvвозможностями, не связанными с перекрытым вводом-выводом. Если оба этих параметра равны nil, или сокет создан без указания флага WSA_FLAG_OVERLAPPED, функция работает в обычном блокирующем или неблокирующем режиме, который установлен для сокета. При этом ее поведение отличается от поведения функции recvтолько тремя незначительными аспектами: во-первых, вместо одного буфера ей можно передать несколько, заполняемых последовательно. Во-вторых, флаги передаются ей не как значение, а как параметр-переменная, и при некоторых условиях функция WSARecvможет их изменять (при использовании TCP и UDP флаги никогда не меняются, поэтому мы не будем рассматривать здесь эту возможность). В-третьих, при успешном завершении функция WSARecvвозвращает ноль, а не число прочитанных байтов (последнее возвращается через параметр lpNumberOfBytesRecvd).

Буферы, в которые нужно поместить данные, передаются функции WSARecvчерез параметр lpBuffers. Он содержит указатель на начало массива структур TWSABuf, а параметр dwBufferCount— число элементов в этом массиве. Ранее мы знакомились со структурой TWSABuf(см. листинг 2.39): она содержит указатель на начало буфера и его размер. Соответственно, массив таких структур определяет набор буферов. При чтении данных заполнение буферов начинается с первого буфера в массиве lpBuffers, затем, если в нем не хватает места, заполняется второй буфер и т.д. Функция не переходит к следующему буферу, пока не заполнит предыдущий до последнего байта. Таким образом, данные, получаемые с помощью функции WSARecv, могут быть помещены в несколько несвязных областей памяти, что иногда бывает удобно, если принимаемые сообщения имеют строго определенный формат с фиксированными размерами компонентов пакета: в этом случае можно каждый компонент поместить в свой независимый буфер.

Теперь переходим непосредственно к рассмотрению перекрытого ввода-вывода на основе событий. Для реализации этого режима при вызове функции WSARecvпараметр lpCompletionRoutineдолжен быть равен nil, а через параметр lpOverlappedпередается указатель на запись TWSAOverlapped, которая определена следующим образом (листинг 2.69).

//***** Описание на C++ *****

struct _WSAOVERLAPPED {

DWORD Internal;

DWORD InternalHigh;

DWORD Offset;

DWORD OffsetHigh;

WSAEVENT hEvent;

} WSAOVERLAPPED, *LPWSAOVEPLAPPED;

// ***** Описание на Delphi *****

PWSAOverlapped = ^TWSAOverlapped;

TWSAOverlapped = packed record

Internal, InternalHigh, Offer, OffsetHigh: DWORD;

hEvent: TWSAEvent;

end;

Поля Internal, InternalHigh, Offsetи OffsetHighпредназначены для внутреннего использования системой, программа не должна выполнять никаких действий с ними. Поле hEventзадает событие, которое будет взведено при завершении операции перекрытого ввода-вывода. Если на момент вызова функции WSARecvданные в буфере сокета отсутствуют, она вернет значение SOCKET_ERROR, а функция WSAGetLastError— WSA_IO_PENDING(997). Это значит, что операция начала выполняться в фоновом режиме. В этом случае функция WSARecvне изменяет значения параметров NumberOfBytesRecvdи Flag. Поля структуры TWSAOverlappedпри этом также модифицируются, и эта структура должна быть сохранена программой в неприкосновенности до окончания операции перекрытого ввода-вывода. После окончания операции будет взведено событие, указанное в поле hEventпараметра lpOverlapped. При необходимости программа может дождаться этого взведения с помощью функции WSAWaitForMultipleEvents.

Как только запрос будет выполнен, в буферах, переданных через параметр lpBuffers, оказываются принятые данные. Но знания одного только факта, что запрос выполнен, недостаточно, чтобы этими данными воспользоваться, потому что, во-первых, неизвестен размер этих данных, а во-вторых, неизвестно, успешно ли завершена операция перекрытого ввода-вывода. Для получения недостающей информации служит функция WSAGetOverlappedResult, прототип которой приведен в листинге 2.70.

// ***** Описание на C++ *****

BOOL WSAGetOverlappedResult(SOCKET s, LPWSAOVERLAPРED lpOverlapped, LPDWORD lpcbTransfer, BOOL fWait, LPDWORD lpdwFlags);

// ***** Описание на Delphi *****

function WSAGetOverlappedResult(S: TSocket; lpOverlapped: PWSAOverlapped; var cbTransfer: DWORD; fWait: BOOL; var Flags: DWORD): BOOL;

Параметры Sи lpOverlappedфункции WSAGetOverlappedResultопределяют coкет и операцию перекрытого ввода-вывода, информацию о которой требуется получить. Их значения должны совпадать со значениями соответствующих параметров, переданных функции WSARecv. Через параметр cbTransferвозвращается число полученных байтов, а через параметр Flags— флаги (напомним, что в случае TCP и UDP флаги не модифицируются, и выходное значение параметра Flagsбудет равно входному значению параметра Flagsфункции WSARecv).

Допускается вызов функции WSAGetOverlappedResultдо того, как операция перекрытого ввода-вывода будет завершена. В этом случае поведение функции зависит от параметра fWait. Если он равен True, функция переводит нить в состояние ожидания до тех пор, пока операция не будет завершена. Если он равен False, функция завершается немедленно с ошибкой WSA_IO_INCOMPLETE(996).

Функция WSAGetOverlappedResultвозвращает True, если операция перекрытого ввода-вывода успешно завершена, и False, если произошли какие-то ошибки. Ошибка может возникнуть в одном из трех случаев:

1. Операция перекрытого ввода-вывода еще не завершена, а параметр fWaitравен False.

2. Операция перекрытого ввода-вывода завершилась с ошибкой (например, из-за разрыва связи).

3. Параметры, переданные функции WSAGetOverlappedResult, имеют некорректные значения.

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

В принципе, программа может вообще не использовать события для отслеживания завершения операции ввода-вывода, а вызывать вместо этого время от времени функцию WSAGetOverlappedResultв удобные для себя моменты. Тогда при вызове функции WSARecvможно указать нулевое значение события hEvent. Но следует иметь в виду, что при вызове функции WSAGetOverlappedResultс параметром fWait, равным True, указанное событие служит для ожидания завершения операции, и если событие не задано, возникнет ошибка. Таким образом, если событие не используется, функция WSAGetOverlappedResultне может вызываться в режиме ожидания.