WSPAsyncSelect

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

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

Parameters

s

[in] A descriptor identifying the socket for which event notification is required.

hWnd

[in] A handle identifying the window which should receive a message when a network event occurs.

wMsg

[in] The message to be sent when a network event occurs.

lEvent

[in] A bitmask which specifies a combination of network events in which the Windows Sockets SPI client is interested.

lpErrno

[out] A pointer to the error code.

This function is used to request that the service provider send a Window message to the client's window hWnd whenever it detects any of the network events specified by the lEvent parameter. The service provider should use the WPUPostMessage function to post the message. 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 or'ing any of the values specified in the following list.

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 follows:

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

It is not possible to specify different messages for different events. The following code 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);
 

Since 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.

When one of the nominated network events occurs on the specified socket s, the service provider uses WPUPostMessage to send message wMsg to the Windows Sockets SPI client's window hWnd. The wParam argument identifies the socket on which a network event has occurred. The low word of lParam specifies the network event that has occurred. The high word of lParam contains any error code. The error code be any error as defined in WS2SPI.H.

The possible network event codes which can be indicated are as follows:

Return Values

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.

Comments

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

A Windows Sockets 2 provider shall 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 message(s) for that network event will be posted to the Windows Sockets SPI client window until the Windows Sockets SPI client makes the function call which implicitly re-enables notification of that network event.

Any call to the re-enabling routine, even one which 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 that 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_QOS and FD_GROUP_QOS events are considered edge triggered. A message will be posted exactly once when a QOS change occurs. Further messages will not be forthcoming until either the provider detects a further change in QOS or the Windows Sockets SPI client renegotiates the QOS for the socket.

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 Windows Socket 2 SPI client has request 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 reissues the IOCTL and another change is detected since the IOCTL has been issued.

If any event has already happened when the Windows Sockets SPI client calls WSPAsyncSelect or when the re-enabling function is called, then a message is posted as appropriate. For example, consider the following sequence: 1) a 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 out-of-band data separately. If the socket is configured to receive out-of-band data in-line, the out-of-band (expedited) data is treated as normal 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 that 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_QOS or FD_GROUP_QOS message is posted when any field in the flow specification associated with socket s or the socket group that s belongs to has changed, respectively. The service provider must update the QOS information available to the client through WSPIoctl with SIO_GET_QOS and/or SIO_GET_GROUP_QOS.

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 Windows Socket 2 SPI client can bind changes AFTER WSPIoctl with SIO_ADDRESS_LIST_CHANGE has been issued.

Here is a summary of events and conditions for each asynchronous notification message:

• FD_READ:
  1. when WSPAsyncSelect is called, if there is data currently available to receive,
  2. when data arrives, if FD_READ not already posted,
  3. after WSPRecv or WSPRecvfrom called (with or without MSG_PEEK), if data is still available to receive.

Note When WSPSetSockOpt SO_OOBINLINE is enabled, "data" includes both normal data and out-of-band (OOB) data in the instances noted above.

• FD_WRITE:
  1. when WSPAsyncSelect called, if a WSPSend or WSPSendTo is possible,
  2. after WSPConnect or WSPAccept called, when connection established,
  3. after WSPSend or WSPSendTo fail with WSAEWOULDBLOCK, when WSPSend or WSPSendTo are likely to succeed,
  4. after WSPBind on a datagram socket. FD_WRITE may or may not occur at this time (implementation dependent). In any case, a connectionless socket is always writeable immediately after WSPBind.
• FD_OOB: Only valid when WSPSetSockOpt SO_OOBINLINE is disabled (default).
  1. when WSPAsyncSelect called, if there is OOB data currently available to receive with the MSG_OOB flag,
  2. when OOB data arrives, if FD_OOB not already posted,
  3. after WSPRecv or WSPRecvfrom called with or without MSG_OOB flag, if OOB data is still available to receive.
• FD_ACCEPT:
  1. when WSPAsyncSelect called, if there is currently a connection request available to accept,
  2. when a connection request arrives, if FD_ACCEPT not already posted,
  3. after WSPAccept called, if there is another connection request available to accept.
• FD_CONNECT:
  1. when WSPAsyncSelect called, if there is currently a connection established,
  2. after WSPConnect called, when connection is established (even when WSPConnect succeeds immediately, as is typical with a datagram socket, and even when it fails immediately).
  3. after WSAJoinLeaf called, when join operation completes.
  4. after connect, WSAConnect, or WSAJoinLeaf was called with a nonblocking, connection-oriented socket. The initial operation returned with a specific error of WSAEWOULDBLOCK, but the network operation went ahead. Whether the operation eventually succeeds or not, when the outcome has been determined, FD_CONNECT happens. The client should check the error code to determine whether the outcome was success or failure.
• FD_CLOSE: Only valid on connection-oriented sockets (for example, SOCK_STREAM)
  1. when WSPAsyncSelect called, if socket connection has been closed,
  2. after remote system initiated graceful close, when no data currently available to receive (note: if data has been received and is waiting to be read when the remote system initiates a graceful close, the FD_CLOSE is not delivered until all pending data has been read),
  3. after local system initiates graceful close with WSPShutdown and remote system has responded with "End of Data" notification (for example, TCP FIN), when no data currently available to receive,
  4. when remote system terminates connection (for example, sent TCP RST), and lParam will contain WSAECONNRESET error value.

     Note FD_CLOSE is not posted after WSPClosesocket is called.

• FD_QOS Reserved for future use with socket groups:
  1. when WSPAsyncSelect called, if the QOS associated with the socket has been changed,
  2. after WSPIoctl with SIO_GET_QOS called, when the QOS is changed.
• FD_GROUP_QOS:
  1. when WSPAsyncSelect called, if the group QOS associated with the socket has been changed,
  2. after WSPIoctl with SIO_GET_GROUP_QOS called, when the group QOS is changed.
• FD_ROUTING_INTERFACE_CHANGE:
  1. after WSPIoctl with SIO_ROUTING_INTERFACE_CHANGE called, when the local interface that should be used to reach the destination specified in the IOCTL changes.
• FD_ADDRESS_LIST_CHANGE:
  1. after WSPIoctl with SIO_ADDRESS_LIST_CHANGE called, when the list of local addresses to which the Windows Socket 2 SPI client can bind changes.

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 field of the message. Possible error codes for each network event are:

Event: FD_CONNECT

Event: FD_CLOSE

Event: FD_READ

Event: FD_WRITE

Event: FD_OOB

Event: FD_ACCEPT

Event: FD_QOS

Event: FD_GROUP_QOS

Event: FD_ADDRESS_LIST_CHANGE

Event: FD_ROUTING_INTERFACE_CHANGE

QuickInfo

  Windows NT: Yes
  Windows: Yes
  Windows CE: Unsupported.
  Header: Declared in ws2spi.h.

See Also

WSPSelect