WSPEnumNetworkEvents

The WSPEnumNetworkEvents function reports occurrences of network events for the indicated socket.

int WSPEnumNetworkEvents (
  SOCKET                s,                             
  WSAEVENT              hEventObject,                
  LPWSANETWORKEVENTS    lpNetworkEvents,   
  LPINT                 lpErrno                         
);

Parameters

s

[in] Descriptor identifying the socket.

hEventObject

[in] An optional handle identifying an associated event object to be reset.

lpNetworkEvents

[out] Pointer to a WSANETWORKEVENTS structure that is filled with a record of occurred network events and any associated error codes. The WSANETWORKEVENTS structure is defined in the following text.

lpErrno

[out] Pointer to the error code.

Return Values

The return value is zero if the operation was successful. Otherwise, the value SOCKET_ERROR is returned, and a specific error number is available in lpErrno.

Remarks

This function is used to report which network events have occurred for the indicated socket since the last invocation of this function. It is intended for use in conjunction with WSPEventSelect, which associates an event object with one or more network events. Recording of network events commences when WSPEventSelect is called with a nonzero lNetworkEvents parameter and remains in effect until another call is made to WSPEventSelect with the lNetworkEvents parameter set to zero, or until a call is made to WSPAsyncSelect.

WSPEnumNetworkEvents only reports network activity and errors nominated through WSPEventSelect. See the descriptions of WSPSelect and WSPAsyncSelect to find out how those functions report network activity and errors.

The socket's internal record of network events is copied to the structure referenced by lpNetworkEvents, whereafter the internal network events record is cleared. If hEventObject is non-NULL, the indicated event object is also reset. The Windows Sockets provider guarantees that the operations of copying the network event record, clearing it, and resetting any associated event object are atomic, such that the next occurrence of a nominated network event will cause the event object to become set. In the case of this function returning SOCKET_ERROR, the associated event object is not reset and the record of network events is not cleared.

The WSANETWORKEVENTS structure is defined as follows:

typedef struct _WSANETWORKEVENTS {
       long lNetworkEvents;
       int iErrorCode[FD_MAX_EVENTS];
} WSANETWORKEVENTS, FAR * LPWSANETWORKEVENTS;

The lNetworkEvent member of the structure indicates which of the FD_XXX network events have occurred. The iErrorCode array is used to contain any associated error codes, with array index corresponding to the position of event bits in lNetworkEvents. The identifiers such as FD_READ_BIT and FD_WRITE_BIT can be used to index the iErrorCode array.

Note that only those elements of the iErrorCode array are set that correspond to the bits set in lNetworkEvents member. Other members are not modified (this is important for backward compatibility with the Windows Socket 2 SPI clients that are not aware of new FD_ROUTING_INTERFACE_CHANGE and FD_ADDRESS_LIST_CHANGE events).

The following error codes can be returned along with the respective network event.

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

Error Codes

Requirements

  Version: Requires Windows Sockets 2.0.
  Header: Declared in Ws2spi.h.

See Also

WSPEventSelect