WSPAsyncSelect (Compact 2013)

3/26/2014

This function requests Windows message-based event notification of network events for a socket.

Syntax

int WSPAsyncSelect(
  SOCKET s,
  HWND hWnd,
  unsigned int wMsg,
  long lEvent,
  LPINT lpErrno 
);

Parameters

• s
  [in] Descriptor identifying the socket for which event notification is required.

• hWnd
  [in] Handle identifying the window that should receive a message when a network event occurs.

• wMsg
  [in] Message to be sent when a network event occurs.

• lEvent
  [in] Bitmask that specifies a combination of network events in which the Windows Sockets SPI client is interested.

• lpErrno
  [out] Pointer to the error code.

This function is used to request that the service provider send a Windows message to the client's window hWnd whenever it detects any of the network events specified by the lEvent parameter. The message to be sent is specified by the wMsg parameter. The socket for which notification is required is identified by s.

This function automatically sets socket s to nonblocking mode, regardless of the value of lEvent. See WSPIoctl about how to set the socket back to blocking mode.

The lEvent parameter is constructed by using the bitwise OR operator with any of the values specified in the following table.

Invoking WSPAsyncSelect for a socket cancels any previous WSPAsyncSelect or WSPEventSelect for the same socket. For example, to receive notification for both reading and writing, the Windows Sockets SPI client must call WSPAsyncSelect with both FD_READ and FD_WRITE, as shown in the following code sample.

rc = WSPAsyncSelect(s, hWnd, wMsg, FD_READ|FD_WRITE, &error);

It is not possible to specify different messages for different events. The following code sample will not work; the second call will cancel the effects of the first, and only FD_WRITE events will be reported with message wMsg2.

rc = WSPAsyncSelect(s, hWnd, wMsg1, FD_READ, &error);
rc = WSPAsyncSelect(s, hWnd, wMsg2, FD_WRITE, &error);

To cancel all notification (for example, to indicate that the service provider should send no further messages related to network events on the socket) lEvent will be set to zero.

rc = WSPAsyncSelect(s, hWnd, 0, 0, &error);

Because a socket created by WSPAccept has the same properties as the listening socket used to accept it, any WSPAsyncSelect events set for the listening socket apply to the accepted socket. For example, if a listening socket has WSPAsyncSelect events FD_ACCEPT, FD_READ and FD_WRITE, then any socket accepted on that listening socket will also have FD_ACCEPT, FD_READ, and FD_WRITE events with the same wMsg value used for messages. If a different wMsg or events are needed, the Windows Sockets SPI client must call WSPAsyncSelect, passing the accepted socket and the new information.

The possible network event codes that may be indicated are shown in the following table.

Return Value

The return value is zero if the Windows Sockets SPI client's declaration of interest in the network event set was successful. Otherwise, the value SOCKET_ERROR is returned, and a specific error code is available in lpErrno.

This function always returns SOCKET_ERROR in Windows Embedded Compact and sets lpErrno to WSASYSCALLFAILURE.

The following table shows other possible error codes.

Additional error codes can be set when the service provider issues a message to a Windows Sockets SPI client's window. This error code is embedded in the lParam member of the message.

The following tables show the possible error codes for each network event.

Event: FD_CONNECT

Event: FD_CLOSE

Event: FD_READ

Event: FD_WRITE

Event: FD_OOB

Event: FD_ACCEPT

Event: FD_ADDRESS_LIST_CHANGE

Event: FD_ROUTING_INTERFACE_CHANGE

Remarks

Although this function can be called with interest in multiple events, the service provider issues the same Windows message for each event.

A Winsock provider will not continually flood a Windows Sockets SPI client with messages for a particular network event. Having successfully posted notification of a particular event to a Windows Sockets SPI client window, no further messages for that network event will be posted to the window until the Windows Sockets SPI client makes the function call that implicitly re-enables notification of that network event.

The following table shows the functions that will re-enable notification of events.

Any call to the re-enabling routine, even one that fails, results in re-enabling of message posting for the relevant event.

For FD_READ, FD_OOB, and FD_ACCEPT events, message posting is level-triggered. This means if the re-enabling routine is called and the relevant condition is still met after the call, a WSPAsyncSelect message is posted to the Windows Sockets SPI client.

The FD_ROUTING_INTERFACE_CHANGE and FD_ADDRESS_LIST_CHANGE events are considered edge triggered as well. A message will be posted exactly once when a change occurs after the Winsock SPI client has requested the notification by issuing WSPIoctl with SIO_ROUTING_INTERFACE_CHANGE or SIO_ADDRESS_LIST_CHANGE correspondingly. Further messages will not be forthcoming until the SPI client re-issues the IOCTL and another change is detected since the IOCTL has been issued.

If any event has already occurred when the Windows Sockets SPI client calls WSPAsyncSelect or when the re-enabling function is called, then an appropriate message is posted. For example, consider the following sequence:

1. An SPI client calls WSPListen.
2. A connect request is received but not yet accepted.
3. The Windows Sockets SPI client calls WSPAsyncSelect specifying that it wants to receive FD_ACCEPT messages for the socket.

Due to the persistence of events, the Windows Sockets service provider posts an FD_ACCEPT message immediately.

The FD_WRITE event is handled slightly differently. An FD_WRITE message is posted when a socket is first connected with WSPConnect (after FD_CONNECT, if also registered) or accepted with WSPAccept, and then after a WSPSend or WSPSendTo fails with WSAEWOULDBLOCK and buffer space becomes available. Therefore, a Windows Sockets SPI client can assume that sends are possible starting from the first FD_WRITE message and lasting until a send returns WSAEWOULDBLOCK. After such a failure the Windows Sockets SPI client will be notified that sends are again possible with an FD_WRITE message.

The FD_OOB event is used only when a socket is configured to receive OOB data separately. If the socket is configured to receive OOB data inline, the OOB (expedited) data is treated as typical data and the Windows Sockets SPI client must register an interest in FD_READ events, not FD_OOB events.

The error code in an FD_CLOSE message indicates whether the socket close was graceful or abortive. If the error code is zero, then the close was graceful; if the error code is WSAECONNRESET, then the socket's virtual circuit was reset. This only applies to connection-oriented sockets such as SOCK_STREAM.

The FD_CLOSE message is posted when a close indication is received for the virtual circuit corresponding to the socket. In TCP terms, this means the FD_CLOSE is posted when the connection goes into the TIME WAIT or CLOSE WAIT states. This results from the remote end performing a WSPShutdown on the send side or a WSPCloseSocket. FD_CLOSE shall only be posted after all data is read from a socket.

In the case of a graceful close, the service provider should only send an FD_CLOSE message to indicate virtual circuit closure after all the received data has been read. It should not send an FD_READ message to indicate this condition.

The FD_ROUTING_INTERFACE_CHANGE message is posted when the local interface that should be used to reach the destination specified in WSPIoctl with SIO_ROUTING_INTERFACE_CHANGE changes after such IOCTL has been issued.

The FD_ADDRESS_LIST_CHANGE message is posted when the list of addresses to which the Winsock SPI client can bind changes after WSPIoctl with SIO_ADDRESS_LIST_CHANGE has been issued.

The following table provides a summary of events and conditions that exists for each asynchronous notification message.

Requirements

See Also

Reference

Winsock SPI Functions
WSPCloseSocket
WSPSelect
WSPShutdown
WSPRecv
WSPRecvFrom
WSPSend
WSPSendTo
WSPAccept
WSPIoctl