Recebendo dados por meio de um soquete de datagrama

Depois que um aplicativo WSK (Winsock Kernel) tiver associado um soquete de datagrama a um endereço de transporte local, ele poderá receber datagramas pelo soquete. Um aplicativo WSK recebe um datagrama em um soquete de datagrama chamando a função WskReceiveFrom .

O exemplo de código a seguir mostra como um aplicativo WSK pode receber um datagrama por meio de um soquete de datagrama.

// Prototype for the receive datagram IoCompletion routine
NTSTATUS
  ReceiveDatagramComplete(
    PDEVICE_OBJECT DeviceObject,
    PIRP Irp,
    PVOID Context
    );

// Function to receive a datagram
NTSTATUS
  ReceiveDatagram(
    PWSK_SOCKET Socket,
    PWSK_BUF DatagramBuffer
    )
{
  PWSK_PROVIDER_DATAGRAM_DISPATCH Dispatch;
  PIRP Irp;
  NTSTATUS Status;

  // Get pointer to the provider dispatch structure
  Dispatch =
    (PWSK_PROVIDER_DATAGRAM_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,
    ReceiveDatagramComplete,
    DatagramBuffer,  // Use the datagram buffer for the context
    TRUE,
    TRUE,
    TRUE
    );

  // Initiate the receive operation on the socket
  Status =
    Dispatch->WskReceiveFrom(
      Socket,
      DatagramBuffer,
      0,  // No flags are specified
      NULL,  // Not interested in the remote address
      NULL,  // Not interested in any associated control information
      NULL,
      NULL,
      Irp
      );

  // Return the status of the call to WskReceiveFrom()
  return Status;
}

// Receive datagram IoCompletion routine
NTSTATUS
  ReceiveDatagramComplete(
    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 datagram
    ...
  }

  // 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 WskReceiveFrom para receber cada datagrama em um soquete de datagrama, um aplicativo WSK pode habilitar a função de retorno de chamada de evento WskReceiveFromEvent no soquete . Se um aplicativo WSK habilitar a função de retorno de chamada de evento WskReceiveFromEvent em um soquete de datagrama, o subsistema WSK chamará a função de retorno de chamada de evento WskReceiveFromEvent do soquete sempre que novos datagramas forem recebidos no soquete. Para obter mais informações sobre como habilitar a função de retorno de chamada de evento WskReceiveFromEvent de um soquete de dados, 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 datagramas pelo subsistema WSK chamando a função de retorno de chamada de evento WskReceiveFromEvent de um soquete de dados.

// A datagram socket's WskReceiveFromEvent
// event callback function
NTSTATUS WSKAPI
  WskReceiveFromEvent(
    PVOID SocketContext,
    ULONG Flags,
    PWSK_DATAGRAM_INDICATION DataIndication
    )
{
  // 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 datagrams were received
    return STATUS_SUCCESS;
  }

  // Error
  else
  {
    // Close the socket
    ...

    // Return success since no datagrams were indicated
    return STATUS_SUCCESS;
  }
}

Se a função de retorno de chamada de evento WskReceiveFromEvent de um soquete de dados não recuperar todos os datagramas da lista de estruturas de WSK_DATAGRAM_INDICATION apontadas pelo parâmetro DataIndication , ela 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_DATAGRAM_INDICATION de volta para o subsistema WSK depois de concluir a recuperação de todos os datagramas das estruturas na lista.