RWWinSockInfo Class Reference
[Essential Networking Module]

Initializes the Winsock DLL on Windows platforms. More...

#include <rw/network/RWWinSockInfo.h>

List of all members.

Public Member Functions
	RWWinSockInfo (short ver=0x0202)
	~RWWinSockInfo (void)
RWCString	getDescription (void) const
int	getMajorVersion (void) const
int	getMinorVersion (void) const
	RWWinSockInfo (FARPROC blockingHook)

---

Detailed Description

Initializes the Winsock DLL on Windows platforms. Initialization is required before your application can make requests of the Winsock API. Deregistration is required for applications that no longer need Winsock services.

Rogue Wave encourages all users to include this class in their code. While using this class does not affect the behavior of programs that run on UNIX, it does make them portable to Windows environments.

Note:

If you use Winsock.dll in a DLL, either directly or indirectly, you must initialize it. The fastest way to do this may be to create an instance of RWWinSockInfo in DllMain().

---

Constructor & Destructor Documentation

RWWinSockInfo::RWWinSockInfo

(

short

ver = 0x0202

)

Initializes the underlying socket API with the requested version. If the Winsock DLL has already been initialized by this application, the constructor does nothing. An exception of type RWNetWinsockInitError is thrown if the initialization fails. This function is a no-op on non Windows platforms.

RWWinSockInfo::~RWWinSockInfo

(

void

)

Performs the termination tasks.

RWWinSockInfo::RWWinSockInfo

(

FARPROC

blockingHook

)

Deprecated:

You can refuse support for this function by defining the macro RW_DISABLE_DEPRECATED.

Initializes the Winsock DLL and installs the blocking hook indicated. The previous blocking hook is restored when the RWWinSockInfo is destroyed.

Condition:

Only available on the Windows platform.

---

Member Function Documentation

RWCString RWWinSockInfo::getDescription

(

void

)

const

Returns the vendor-supplied description of the Winsock DLL. The string "not winsock" is returned on platforms that do not support winsock.

int RWWinSockInfo::getMajorVersion

(

void

)

const

Returns the vendor-supplied major version of the Winsock DLL. Returns 0 on platforms that do not support Winsock.

int RWWinSockInfo::getMinorVersion

(

void

)

const

Returns the vendor-supplied minor version of the Winsock DLL. Returns 0 on platforms that do not support Winsock.