Home Units Hierarchy Routines All identifiers

Class unaWSA

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type unaWSA = class(unaObject)

Description

Windows sockets manager class.

Hierarchy

Overview

Methods

Public constructor create(active: bool = true; version: uint32 = $0101);
Public destructor Destroy(); override;
Public function getStatus(): int;
Public function isActive(): bool;
Public function shutdown(): int;
Public function startup(version: uint32 = $0101): int;

Description

Methods

Public constructor create(active: bool = true; version: uint32 = $0101);

Creates and initializes internal structures. If active = true (default) startups the Windows Sockets as well.

Parameters
active
Startup Windows sockets (default is True).
version
Required WinSock version (default is $0101).
Public destructor Destroy(); override;

Shuts down Windows sockets if they were started.

Public function getStatus(): int;

Returns last status of startup().

Returns

WSASYSNOTREADY, WSAVERNOTSUPPORTED, WSAEINPROGRESS, WSAEPROCLIM, WSAEFAULT, ...

Public function isActive(): bool;

Returns True if getStatus() = 0.

Returns

True if Windows sockets were started up successfully.

Public function shutdown(): int;

Cleanups the Windows sockets.

Public function startup(version: uint32 = $0101): int;

Startups the Windows sockets.

Parameters
version
Expected sockets version number.

(c) 2012 Lake of Soft


Generated by PasDoc 0.12.1 on 2012-10-09