Tenouk C & C++ |< Winsock Functions 3 | Winsock Main Page | Site Index | Download | Linux Socket | Winsock in .NET


 

 

 

 

 

 

Winsock 2 References:

Functions, structures etc. used in program examples Part 2

 

 

 

 

 

 

 

 

Winsock Reference

 

Winsock reference for:

  1. Generic Data Transport Functions - SPI (WSP *).

  2. Windows Sockets error codes.

 

Generic Data Transport Functions

 

This section lists the data transport functions exposed by ws2spi.h.

 

Function

Description

WSPAccept()

An incoming connection is acknowledged and associated with an immediately created socket. The original socket is returned to the listening state. This function also allows for conditional acceptance.

WSPAsyncSelect()

Performs asynchronous version of WSPSelect().

WSPBind()

Assigns a local name to an unnamed socket.

WSPCancelBlockingCall()

Cancels an outstanding blocking Windows Sockets call.

WSPCleanup()

Signs off from the underlying Windows Sockets service provider.

WSPCloseSocket()

Removes a socket from the per-process object reference table. Only blocks if SO_LINGER is set with a nonzero time-out on a blocking socket.

WSPConnect()

Initiates a connection on the specified socket. This function also allows for exchange of connect data and QOS specification.

WSPDuplicateSocket()

Returns a WSAPROTOCOL_INFO structure that can be used to create a new socket descriptor for a shared socket.

WSPEnumNetworkEvents()

Discovers occurrences of network events.

WSPEventSelect()

Associates network events with an event object.

WSPGetOverlappedResult()

Gets completion status of overlapped operation.

WSPGetPeerName()

Retrieves the name of the peer connected to the specified socket.

WSPGetSockName()

Retrieves the local address to which the specified socket is bound.

WSPGetSockOpt()

Retrieves options associated with the specified socket.

WSPGetQOSByName()

Supplies QOS parameters based on a well-known service name.

WSPIoctl()

Provides control for sockets.

WSPJoinLeaf()

Joins a leaf node into a multipoint session.

WSPListen()

Listens for incoming connections on a specified socket.

WSPRecv()

Receives data from a connected or unconnected socket. This function accommodates scatter/gather I/O, overlapped sockets, and provides the flags parameter as IN/OUT.

WSPRecvDisconnect()

Terminates reception on a socket, and retrieve the disconnect data if the socket is connection-oriented.

WSPRecvFrom()

Receives data from either a connected or unconnected socket. This function accommodates scatter/gather I/O, overlapped sockets and provides the flags parameter as IN/OUT.

WSPSelect()

Performs synchronous I/O multiplexing.

WSPSend()

Sends data to a connected socket. This function also accommodates scatter/gather I/O and overlapped sockets.

WSPSendDisconnect

Initiates termination of a socket connection and optionally send disconnect data.

WSPSendTo()

Sends data to either a connected or unconnected socket. This function also accommodates scatter/gather I/O and overlapped sockets.

WSPSetSockOpt()

Stores options associated with the specified socket.

WSPShutdown()

Shuts down part of a full-duplex connection.

WSPSocket()

A socket creation function which takes a WSAPROTOCOL_INFO structure as input and allows overlapped sockets to be created.

WSPStartup()

Initializes the underlying Windows Sockets service provider.

 

Table 1

 

Error Codes - errno, h_errno and WSAGetLastError()

 

Error codes set by Windows Sockets are not made available through the errno variable. Additionally, for the getXbyY class of functions, error codes are not made available through the h_errno variable. Instead, error codes are accessed by using the WSAGetLastError() function. This function is provided in Windows Sockets as a precursor (and eventually an alias) for the Microsoft Windows function GetLastError(). This is intended to provide a reliable way for a thread in a multithreaded process to obtain per-thread error information. For compatibility with BSD, an application may choose to include a line of the form:

#define errno WSAGetLastError

This allows networking code which was written to use the global errno to work correctly in a single-threaded environment. There are, obviously, some drawbacks. If a source file includes code which inspects errno for both socket and non-socket functions, this mechanism cannot be used. Furthermore, it is not possible for an application to assign a new value to errno. In Windows Sockets the function WSASetLastError() may be used for this purpose.

 

TYPICAL BSD STYLE

r = recv(...);

if (r == -1

    && errno == EWOULDBLOCK)

    {...}

PREFERRED STYLE

r = recv(...);

if (r == -1       /* (but see below) */

    && WSAGetLastError() == EWOULDBLOCK)

    {...}

Although error constants consistent with Berkeley Sockets 4.3 are provided for compatibility purposes, applications should, where possible, use the WSA error code definitions. This is because error codes returned by certain Windows Sockets routines fall into the standard range of error codes as defined by Microsoft C. Thus, a better version of the preceding source code fragment is:

r = recv(...);

if (r == -1       /* (but see below) */

    && WSAGetLastError() == WSAEWOULDBLOCK)

    {...}

This specification defines a recommended set of error codes, and lists the possible errors that can be returned as a result of each function. It may be the case in some implementations that other Windows Sockets error codes are returned in addition to those listed, and applications should be prepared to handle errors other than those enumerated under each function description. However, Windows Sockets does not return any value that is not enumerated in the table of legal Windows Sockets errors given in the following section.

 

 

 

 

 

 

 

 

  

 

 

 

 

 

 

 

 

 

 

Windows Sockets Error Codes

 

The following list describes the possible error codes returned by the WSAGetLastError() function. Errors are listed in alphabetical order by error macro. Some error codes defined in winsock2.h are not returned from any function - these are not included in this list.

 

 

Return code/value

Description

WSAEINTR 10004

Interrupted function call. A blocking operation was interrupted by a call to WSACancelBlockingCall().

WSAEACCES 10013

Permission denied. An attempt was made to access a socket in a way forbidden by its access permissions. An example is using a broadcast address for sendto() without broadcast permission being set using setsockopt(SO_BROADCAST). Another possible reason for the WSAEACCES error is that when the bind() function is called (on Windows NT 4 SP4 or later), another application, service, or kernel mode driver is bound to the same address with exclusive access. Such exclusive access is a new feature of Windows NT 4 SP4 and later, and is implemented by using the SO_EXCLUSIVEADDRUSE option.

WSAEFAULT 10014

Bad address. The system detected an invalid pointer address in attempting to use a pointer argument of a call. This error occurs if an application passes an invalid pointer value, or if the length of the buffer is too small. For instance, if the length of an argument, which is a sockaddr structure, is smaller than the sizeof(sockaddr).

WSAEINVAL 10022

Invalid argument. Some invalid argument was supplied (for example, specifying an invalid level to the setsockopt() function). In some instances, it also refers to the current state of the socket - for instance, calling accept() on a socket that is not listening.

WSAEMFILE 10024

Too many open files. Too many open sockets. Each implementation may have a maximum number of socket handles available, either globally, per process, or per thread.

WSAEWOULDBLOCK 10035

Resource temporarily unavailable. This error is returned from operations on non-blocking sockets that cannot be completed immediately, for example recv() when no data is queued to be read from the socket. It is a nonfatal error, and the operation should be retried later. It is normal for WSAEWOULDBLOCK to be reported as the result from calling connect() on a non-blocking SOCK_STREAM socket, since some time must elapse for the connection to be established.

WSAEINPROGRESS 10036

Operation now in progress. A blocking operation is currently executing. Windows Sockets only allows a single blocking operation - per- task or thread - to be outstanding, and if any other function call is made (whether or not it references that or any other socket) the function fails with the WSAEINPROGRESS error.

WSAEALREADY 10037

Operation already in progress. An operation was attempted on a non-blocking socket with an operation already in progress - that is, calling connect() a second time on a non-blocking socket that is already connecting, or canceling an asynchronous request (WSAAsyncGetXbyY) that has already been canceled or completed.

WSAENOTSOCK 10038

Socket operation on non-socket. An operation was attempted on something that is not a socket. Either the socket handle parameter did not reference a valid socket, or for select(), a member of an fd_set was not valid.

WSAEDESTADDRREQ 10039

Destination address required. A required address was omitted from an operation on a socket. For example, this error is returned if sendto is called with the remote address of ADDR_ANY.

WSAEMSGSIZE 10040

Message too long. A message sent on a datagram socket was larger than the internal message buffer or some other network limit, or the buffer used to receive a datagram was smaller than the datagram itself.

WSAEPROTOTYPE 10041

Protocol wrong type for socket. A protocol was specified in the socket() function call that does not support the semantics of the socket type requested. For example, the ARPA Internet UDP protocol cannot be specified with a socket type of SOCK_STREAM.

WSAENOPROTOOPT 10042

Bad protocol option. An unknown, invalid or unsupported option or level was specified in a getsockopt() or setsockopt() call.

WSAEPROTONOSUPPORT 10043

Protocol not supported. The requested protocol has not been configured into the system, or no implementation for it exists. For example, a socket() call requests a SOCK_DGRAM socket, but specifies a stream protocol.

WSAESOCKTNOSUPPORT 10044

Socket type not supported. The support for the specified socket type does not exist in this address family. For example, the optional type SOCK_RAW might be selected in a socket() call, and the implementation does not support SOCK_RAW sockets at all.

WSAEOPNOTSUPP 10045

Operation not supported. The attempted operation is not supported for the type of object referenced. Usually this occurs when a socket descriptor to a socket that cannot support this operation is trying to accept a connection on a datagram socket.

WSAEPFNOSUPPORT 10046

Protocol family not supported. The protocol family has not been configured into the system or no implementation for it exists. This message has a slightly different meaning from WSAEAFNOSUPPORT. However, it is interchangeable in most cases, and all Windows Sockets functions that return one of these messages also specify WSAEAFNOSUPPORT.

WSAEAFNOSUPPORT 10047

Address family not supported by protocol family. An address incompatible with the requested protocol was used. All sockets are created with an associated address family (that is, AF_INET for Internet Protocols) and a generic protocol type (that is, SOCK_STREAM). This error is returned if an incorrect protocol is explicitly requested in the socket() call, or if an address of the wrong family is used for a socket, for example, in sendto().

WSAEADDRINUSE 10048

Address already in use. Typically, only one usage of each socket address (protocol/IP address/port) is permitted. This error occurs if an application attempts to bind() a socket to an IP address/port that has already been used for an existing socket, or a socket that was not closed properly, or one that is still in the process of closing. For server applications that need to bind multiple sockets to the same port number, consider using setsockopt() (SO_REUSEADDR). Client applications usually need not call bind at all - connect() chooses an unused port automatically. When bind() is called with a wildcard address (involving ADDR_ANY), a WSAEADDRINUSE error could be delayed until the specific address is committed. This could happen with a call to another function later, including connect(), listen(), WSAConnect(), or WSAJoinLeaf().

WSAEADDRNOTAVAIL 10049

Cannot assign requested address. The requested address is not valid in its context. This normally results from an attempt to bind() to an address that is not valid for the local computer. This can also result from connect(), sendto(), WSAConnect(), WSAJoinLeaf(), or WSASendTo() when the remote address or port is not valid for a remote computer (for example, address or port 0).

WSAENETDOWN 10050

Network is down. A socket operation encountered a dead network. This could indicate a serious failure of the network system (that is, the protocol stack that the Windows Sockets DLL runs over), the network interface, or the local network itself.

WSAENETUNREACH 10051

Network is unreachable. A socket operation was attempted to an unreachable network. This usually means the local software knows no route to reach the remote host.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

WSAENETRESET 10052

Network dropped connection on reset. The connection has been broken due to keep-alive activity detecting a failure while the operation was in progress. It can also be returned by setsockopt() if an attempt is made to set SO_KEEPALIVE on a connection that has already failed.

WSAECONNABORTED 10053

Software caused connection abort. An established connection was aborted by the software in your host computer, possibly due to a data transmission time-out or protocol error.

WSAECONNRESET 10054

Connection reset by peer. An existing connection was forcibly closed by the remote host. This normally results if the peer application on the remote host is suddenly stopped, the host is rebooted, the host or remote network interface is disabled, or the remote host uses a hard close (see setsockopt() for more information on the SO_LINGER option on the remote socket). This error may also result if a connection was broken due to keep-alive activity detecting a failure while one or more operations are in progress. Operations that were in progress fail with WSAENETRESET. Subsequent operations fail with WSAECONNRESET.

WSAENOBUFS 10055

No buffer space available. An operation on a socket could not be performed because the system lacked sufficient buffer space or because a queue was full.

WSAEISCONN 10056

Socket is already connected. A connect request was made on an already-connected socket. Some implementations also return this error if sendto() is called on a connected SOCK_DGRAM socket (for SOCK_STREAM sockets, the to parameter in sendto() is ignored) although other implementations treat this as a legal occurrence.

WSAENOTCONN 10057

Socket is not connected. A request to send or receive data was disallowed because the socket is not connected and (when sending on a datagram socket using sendto()) no address was supplied. Any other type of operation might also return this error - for example, setsockopt() setting SO_KEEPALIVE if the connection has been reset.

WSAESHUTDOWN 10058

Cannot send after socket shutdown. A request to send or receive data was disallowed because the socket had already been shut down in that direction with a previous shutdown() call. By calling shutdown() a partial close of a socket is requested, which is a signal that sending or receiving, or both have been discontinued.

WSAETIMEDOUT 10060

Connection timed out. A connection attempt failed because the connected party did not properly respond after a period of time, or the established connection failed because the connected host has failed to respond.

WSAECONNREFUSED 10061

Connection refused. No connection could be made because the target computer actively refused it. This usually results from trying to connect to a service that is inactive on the foreign host - that is, one with no server application running.

WSAEHOSTDOWN 10064

Host is down. A socket operation failed because the destination host is down. A socket operation encountered a dead host. Networking activity on the local host has not been initiated. These conditions are more likely to be indicated by the error WSAETIMEDOUT.

WSAEHOSTUNREACH 10065

No route to host. A socket operation was attempted to an unreachable host. See WSAENETUNREACH.

WSAEPROCLIM 10067

Too many processes. A Windows Sockets implementation may have a limit on the number of applications that can use it simultaneously. WSAStartup() may fail with this error if the limit has been reached.

WSASYSNOTREADY 10091

Network subsystem is unavailable. This error is returned by WSAStartup() if the Windows Sockets implementation cannot function at this time because the underlying system it uses to provide network services is currently unavailable. Users should check:

  • That the appropriate Windows Sockets DLL file is in the current path.

  • That they are not trying to use more than one Windows Sockets implementation simultaneously. If there is more than one Winsock DLL on your system, be sure the first one in the path is appropriate for the network subsystem currently loaded. The Windows Sockets implementation documentation to be sure all necessary components are currently installed and configured correctly.

WSAVERNOTSUPPORTED 10092

Winsock.dll version out of range. The current Windows Sockets implementation does not support the Windows Sockets specification version requested by the application. Check that no old Windows Sockets DLL files are being accessed.

WSANOTINITIALISED 10093

Successful WSAStartup not yet performed. Either the application has not called WSAStartup() or WSAStartup() failed. The application may be accessing a socket that the current active task does not own (that is, trying to share a socket between tasks), or WSACleanup() has been called too many times.

WSAEDISCON 10101

Graceful shutdown in progress. Returned by WSARecv() and WSARecvFrom() to indicate that the remote party has initiated a graceful shutdown sequence.

WSATYPE_NOT_FOUND 10109

Class type not found. The specified class was not found.

WSAHOST_NOT_FOUND 11001

Host not found. No such host is known. The name is not an official host name or alias, or it cannot be found in the database(s) being queried. This error may also be returned for protocol and service queries, and means that the specified name could not be found in the relevant database.

WSATRY_AGAIN 11002

Non-authoritative host not found. This is usually a temporary error during host name resolution and means that the local server did not receive a response from an authoritative server. A retry at some time later may be successful.

WSANO_RECOVERY 11003

This is a non-recoverable error. This indicates that some sort of non-recoverable error occurred during a database lookup. This may be because the database files (for example, BSD-compatible HOSTS, SERVICES, or PROTOCOLS files) could not be found, or a DNS request was returned by the server with a severe error.

WSANO_DATA 11004

Valid name, no data record of requested type. The requested name is valid and was found in the database, but it does not have the correct associated data being resolved for. The usual example for this is a host name-to-address translation attempt (using gethostbyname() or WSAAsyncGetHostByName()) which uses the DNS (Domain Name Server). An MX record is returned but no A record - indicating the host itself exists, but is not directly reachable.

WSA_INVALID_HANDLE OS dependent

Specified event object handle is invalid. An application attempts to use an event object, but the specified handle is not valid.

WSA_INVALID_PARAMETER OS dependent

One or more parameters are invalid. An application used a Windows Sockets function which directly maps to a Windows function. The Windows function is indicating a problem with one or more parameters.

WSA_IO_INCOMPLETE OS dependent

Overlapped I/O event object not in signaled state. The application has tried to determine the status of an overlapped operation which is not yet completed. Applications that use WSAGetOverlappedResult() (with the fWait flag set to FALSE) in a polling mode to determine when an overlapped operation has completed, get this error code until the operation is complete.

WSA_IO_PENDING OS dependent

Overlapped operations will complete later. The application has initiated an overlapped operation that cannot be completed immediately. A completion indication will be given later when the operation has been completed.

WSA_NOT_ENOUGH_MEMORY OS dependent

Insufficient memory available. An application used a Windows Sockets function that directly maps to a Windows function. The Windows function is indicating a lack of required memory resources.

WSA_OPERATION_ABORTED OS dependent

Overlapped operation aborted. An overlapped operation was canceled due to the closure of the socket, or the execution of the SIO_FLUSH command in WSAIoctl().

WSAINVALIDPROCTABLE OS dependent

Invalid procedure table from service provider. A service provider returned a bogus procedure table to ws2_32.dll. (This is usually caused by one or more of the function pointers being null.)

WSAINVALIDPROVIDER OS dependent

Invalid service provider version number. A service provider returned a version number other than 2.0.

WSAPROVIDERFAILEDINIT OS dependent

Unable to initialize a service provider. Either a service provider's DLL could not be loaded (LoadLibrary() failed) or the provider's WSPStartup()/NSPStartup() function failed.

WSASYSCALLFAILURE OS dependent

System call failure. Generic error code, returned under various conditions. Returned when a system call that should never fail does fail. For example, if a call to WaitForMultipleEvents() fails or one of the registry functions fails trying to manipulate the protocol/namespace catalogs. Returned when a provider does not return SUCCESS and does not provide an extended error code. Can indicate a service provider implementation error.

 

Table 2

 

 

------WINSOCK: WINDOWS SOCKET END HERE------

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Further reading and digging:

 

  1. Check the best selling C / C++ and Windows books at Amazon.com.

  2. Linux and TCP/IP.

  3. Linux Sockets: Story and program examples.

  4. Structure, enum, union and typedef story can be found struct, enum, union & typedef tutorial.

  5. For Multibytes, Unicode characters and Localization please refer to Multibyte, Unicode and wide characters (Story) and Win32 Windows & Users tutorial (Implementation).

  6. A complete info on Windows socket reference from MSDN which include managed and unmanaged API doc.

  7. Windows data type information is Win32 - Windows data types.

 

 


 

Tenouk C & C++ |< Winsock Functions 3 | Winsock Main Page | Site Index | Download | Linux Socket | Winsock in .NET