Recebendo dados em um soquete Connection-Oriented
Depois que um aplicativo WSK (Winsock Kernel) tiver conectado um soquete orientado à conexão a um endereço de transporte remoto, ele poderá receber dados pelo soquete. Um aplicativo WSK também pode receber dados por meio de um soquete orientado à conexão que ele aceitou em um soquete de escuta. Um aplicativo WSK recebe dados por meio de um soquete orientado a conexão chamando a função WskReceive .
O exemplo de código a seguir mostra como um aplicativo WSK pode receber dados por meio de um soquete orientado à conexão.
// Prototype for the receive IoCompletion routine
NTSTATUS
ReceiveComplete(
PDEVICE_OBJECT DeviceObject,
PIRP Irp,
PVOID Context
);
// Function to receive data
NTSTATUS
ReceiveData(
PWSK_SOCKET Socket,
PWSK_BUF DataBuffer
)
{
PWSK_PROVIDER_CONNECTION_DISPATCH Dispatch;
PIRP Irp;
NTSTATUS Status;
// Get pointer to the provider dispatch structure
Dispatch =
(PWSK_PROVIDER_CONNECTION_DISPATCH)(Socket->Dispatch);
// Allocate an IRP
Irp =
IoAllocateIrp(
1,
FALSE
);
// Check result
if (!Irp)
{
// Return error
return STATUS_INSUFFICIENT_RESOURCES;
}
// Set the completion routine for the IRP
IoSetCompletionRoutine(
Irp,
ReceiveComplete,
DataBuffer, // Use the data buffer for the context
TRUE,
TRUE,
TRUE
);
// Initiate the receive operation on the socket
Status =
Dispatch->WskReceive(
Socket,
DataBuffer,
0, // No flags are specified
Irp
);
// Return the status of the call to WskReceive()
return Status;
}
// Receive IoCompletion routine
NTSTATUS
ReceiveComplete(
PDEVICE_OBJECT DeviceObject,
PIRP Irp,
PVOID Context
)
{
UNREFERENCED_PARAMETER(DeviceObject);
PWSK_BUF DataBuffer;
ULONG ByteCount;
// Check the result of the receive operation
if (Irp->IoStatus.Status == STATUS_SUCCESS)
{
// Get the pointer to the data buffer
DataBuffer = (PWSK_BUF)Context;
// Get the number of bytes received
ByteCount = (ULONG)(Irp->IoStatus.Information);
// Process the received data
...
}
// Error status
else
{
// Handle error
...
}
// Free the IRP
IoFreeIrp(Irp);
// Always return STATUS_MORE_PROCESSING_REQUIRED to
// terminate the completion processing of the IRP.
return STATUS_MORE_PROCESSING_REQUIRED;
}
Como alternativa para chamar a função WskReceive para receber dados em um soquete orientado a conexão, um aplicativo WSK pode habilitar a função de retorno de chamada de evento WskReceiveEvent no soquete . Se um aplicativo WSK habilitar a função de retorno de chamada de evento WskReceiveEvent em um soquete orientado à conexão, o subsistema WSK chamará a função de retorno de chamada de evento WskReceiveEvent do soquete sempre que novos dados forem recebidos no soquete. Para obter mais informações sobre como habilitar a função de retorno de chamada de evento WskReceiveEvent de um soquete orientado a conexão, consulte Habilitando e desabilitando funções de retorno de chamada de evento.
O exemplo de código a seguir mostra como um aplicativo WSK pode receber dados pelo subsistema WSK chamando a função de retorno de chamada de evento WskReceiveEvent de um soquete orientado a conexão.
// A connection-oriented socket's WskReceiveEvent
// event callback function
NTSTATUS WSKAPI
WskReceiveEvent(
PVOID SocketContext,
ULONG Flags,
PWSK_DATA_INDICATION DataIndication,
SIZE_T BytesIndicated,
SIZE_T *BytesAccepted
)
{
// Check for a valid data indication
if (DataIndication != NULL)
{
// Loop through the list of data indication structures
while (DataIndication != NULL)
{
// Process the data in the data indication structure
...
// Move to the next data indication structure
DataIndication = DataIndication->Next;
}
// Return status indicating the data was received
return STATUS_SUCCESS;
}
// Error
else
{
// Close the socket
...
// Return success since no data was indicated
return STATUS_SUCCESS;
}
}
Se a função de retorno de chamada de evento WskReceiveEvent de um soquete orientado a conexão não recuperar todos os dados contidos na lista de estruturas de WSK_DATA_INDICATION apontadas pelo parâmetro DataIndication , ele poderá manter a lista para processamento adicional retornando STATUS_PENDING. Nessa situação, o aplicativo WSK deve chamar a função WskRelease para liberar a lista de estruturas de WSK_DATA_INDICATION de volta para o subsistema WSK depois de concluir a recuperação de todos os dados das estruturas na lista.
Se a função de retorno de chamada de evento WskReceiveEvent de um soquete orientado a conexão aceitar apenas uma parte do número total de bytes de dados recebidos, ela deverá definir a variável apontada pelo parâmetro BytesAccepted para o número de bytes de dados que foram realmente aceitos. No entanto, se a função de retorno de chamada de evento WskReceiveEvent do soquete aceitar todos os dados recebidos, ela não precisará definir a variável apontada pelo parâmetro BytesAccepted .