Home Units Hierarchy Routines All identifiers

Class unaSocks

Description

Hierarchy

Fields

Methods

Properties

Unit

unaSockets

Declaration

type unaSocks = class(unaObject)

Description

This class is used to create server and client sockets and manage the connections.

Hierarchy

TObject
unaObject
unaSocks

Overview

Methods

	`constructor create(threadsInPool: unsigned = 4 );`
	`destructor Destroy(); override;`
	`function activate(id: tConID): bool;`
	`function closeThread(id: tConID; timeout: tTimeout = 2700): bool;`
	`function createConnection(const host, port: string; protocol: int = IPPROTO_TCP; activate: bool = true; const bindToIP: string = '0.0.0.0'; const bindToPort: string = '0' ): tConID;`
	`function createServer(const port: string; protocol: int = IPPROTO_TCP; activate: bool = true; backlog: int = SOMAXCONN; udpConnectionTimeout: tTimeout = c_defUdpConnTimeout; const bindToIP: string = '0.0.0.0' ): tConID;`
	`function enter(ro: bool; timeout: tTimeout = tTimeout(INFINITE)): bool;`
	`function getConnection(id: tConID; connId: tConID; timeout: tTimeout = 2000; needAcquire: bool = true): unaSocksConnection;`
	`function getRemoteHostAddr(id, connId: tConID): pSockAddrIn;`
	`function getRemoteHostInfo(addr: pSockAddrIn; out ip, port: string): bool; overload;`
	`function getRemoteHostInfo(id, connId: tConID; out ip, port: string): bool; overload;`
	`function getRemoteHostInfoEx(id, connId: tConID; out ip, port: string; out proto: int): bool;`
	`function getSocketError(id: tConID; needLock: bool = true): int;`
	`function getThreadByID(id: tConID; timeout: tTimeout = 1000): unaSocksThread;`
	`function getThreadSocket(id: tConID): unaSocket;`
	`function isActive(id: tConID): bool;`
	`function okToWrite(id, connId: tConID; timeout: tTimeout = 100; noCheckState: bool = false): bool;`
	`function removeConnection(id: tConID; connId: tConID): bool;`
	`function sendData(id: tConID; data: pointer; size: uint; connId: tConID; out asynch: bool; noCheck: bool = false; timeout: tTimeout = 500): uint;`
	`procedure clear(clearServers: bool = false; clearClients: bool = false);`
	`procedure leaveRO();`
	`procedure leaveWO();`
	`procedure setPoolSize(threadsInPool: unsigned);`
	`procedure event(event: unaSocketEvent; id, connId: tConID; data: pointer = nil; size: uint = 0); virtual;`

Properties

property onEvent: unaSocksOnEventEvent read f_onEvent write f_onEvent;

Description

Methods

constructor create(threadsInPool: unsigned = 4 );

Creates socks object.

Parameters

threadsInPool: Number of threads to create in pool (default is 4).
isIOCP: Use IOCP for sockets' operations (default is False).

	`destructor Destroy(); override;`
Destroys socks object.

function activate(id: tConID): bool;

Activate a thread (start server or connect client).

Parameters

id: Thread id to activate.

Returns

True if thread was started successfully.

function closeThread(id: tConID; timeout: tTimeout = 2700): bool;

Closes and removes all connection for specified thread. Also stops the thread and makes it available for new connections.

Parameters

id: Thread id.
timeout: Timeout in ms (default is 2700).

Returns

True if operation was successfull.

function createConnection(const host, port: string; protocol: int = IPPROTO_TCP; activate: bool = true; const bindToIP: string = '0.0.0.0'; const bindToPort: string = '0' ): tConID;

Creates new client socket. Returns thread id which will handle events for this client connection or 0 if some error occured.

Parameters

host: Remote host to connect to.
port: Remote port to connect to.
protocol: Proto (UDP or TCP, default is IPPROTO_TCP).
activate: Connect client after creation (default is True).
bindToIP: Bind to this local IP (default is '0.0.0.0').
bindToPort: Bind to this local port (default is '0').
overlapped: Create overlapped socket (default is True).

Returns

Thread id or 0 if some error occured.

function createServer(const port: string; protocol: int = IPPROTO_TCP; activate: bool = true; backlog: int = SOMAXCONN; udpConnectionTimeout: tTimeout = c_defUdpConnTimeout; const bindToIP: string = '0.0.0.0' ): tConID;

Creates new server socket. Returns thread id which will handle connections for this socket or 0 if some error occur.

Parameters

port: Local port to listen at.
protocol: Proto (UDP or TCP, default is IPPROTO_TCP).
activate: Start server after creation (default is True).
backlog: Number of pending client connections (default is SOMAXCONN).
udpConnectionTimeout: Timeout for UDP clients (default is c_defUdpConnTimeout (3 minutes)).
bindToIP: Bind to this local IP (default is '0.0.0.0').
overlapped: Create overlapped socket (default is True).

Returns

Thread id or 0 if some error occured.

function enter(ro: bool; timeout: tTimeout = tTimeout(INFINITE)): bool;

Locks socks object.

Parameters

timeout: Timeout (default is INFINITE).

function getConnection(id: tConID; connId: tConID; timeout: tTimeout = 2000; needAcquire: bool = true): unaSocksConnection;

Returns specified connection.

WARNING! If needAcquire was True (default), you must call release() method of returned connection when it is no longer needed.

Parameters

id: Thread id which handles the connection.
connId: Client connection id (0 for client threads).
timeout: Timeout in ms for acquiring (if needAcquire is True, default is 2000).
needAcquire: Lock connection object before returning (default is True).

Returns

Connection object or nil.

function getRemoteHostAddr(id, connId: tConID): pSockAddrIn;

Returns remote address for connection.

Parameters

id: Thread id which handles the connection.
connId: Client connection id (0 for client threads).

Returns

Pointer to address record or nil.

function getRemoteHostInfo(addr: pSockAddrIn; out ip, port: string): bool; overload;

Converts address record into IP and port.

Parameters

addr: Address record.
ip: [OUT] Remote IP.
port: [OUT] Remote port.

Returns

True if function was successfull.

function getRemoteHostInfo(id, connId: tConID; out ip, port: string): bool; overload;

Returns remote IP and port for connection.

Parameters

id: Thread id which handles the connection.
connId: Client connection id (0 for client threads).
ip: [OUT] Remote IP.
port: [OUT] Remote port.

Returns

True if function was successfull.

function getRemoteHostInfoEx(id, connId: tConID; out ip, port: string; out proto: int): bool;

Returns remote IP, port and proto for connection.

Parameters

id: Thread id which handles the connection.
connId: Client connection id (0 for client threads).
ip: [OUT] Remote IP.
port: [OUT] Remote port.
proto: [OUT] Remote proto (IPPROTO_TCP/IPPROTO_UDP).

Returns

True if function was successfull.

function getSocketError(id: tConID; needLock: bool = true): int;

Returns socket error for a thread.

Parameters

id: Thread id.
needLock: Lock the threads (defualt is True).

Returns

Error code.

function getThreadByID(id: tConID; timeout: tTimeout = 1000): unaSocksThread;

Returns thread object.

Parameters

id: Thread id.

Returns

Thread object or nil.

function getThreadSocket(id: tConID): unaSocket;

Returns socket object assigned to a thread.

Parameters

id: Thread id.

Returns

Socket object or nil.

function isActive(id: tConID): bool;

Returns thread active state.

Returns

True if thread is active (server is listening, client is connected).

function okToWrite(id, connId: tConID; timeout: tTimeout = 100; noCheckState: bool = false): bool;

Returns true if it seems that we can send data to remote side over specified connection.

Parameters

id: Thread id which handles the connection.
connId: Client connection id (0 for client threads).
timeout: Timeout in ms for error checking (valid if noCheck is False, default is 100).
noCheckState: Do not check the state of connection before sending (speeds up sending a little, default is False).

Returns

True if data can be send.

function removeConnection(id: tConID; connId: tConID): bool;

Closes and removes specified connection. If thread has no more connections, closes it as well.

Parameters

id: Thread id which handles the connection.
connId: Client connection id (0 for client threads).

Returns

True if connection was closed.

function sendData(id: tConID; data: pointer; size: uint; connId: tConID; out asynch: bool; noCheck: bool = false; timeout: tTimeout = 500): uint;

Sends data to remote side over specified connection.

Parameters

id: Thread id which handles the connection.
data: Data buffer to send.
size: Size of data buffer.
connId: Client connection id (0 for client threads).
noCheck: Do not check the state of connection before sending (speeds up sending a little, default is False).
timeout: Timeout in ms for error checking (valid if noCheck is False, default is 1000).

Returns

0 if data was sent successfully, or specific WSA error otherwise.

procedure clear(clearServers: bool = false; clearClients: bool = false);

Closes all client or server (or both) threads.

Parameters

clearServers: Close all server threads (default is False).
clearClients: Close all client threads (default is False).

	`procedure leaveRO();`
Unlocks socks object.

	`procedure leaveWO();`
Unlocks socks object.

procedure setPoolSize(threadsInPool: unsigned);

Sets new pool size.

Parameters

threadsInPool: Specifies the number of threads in the pool to be created.

procedure event(event: unaSocketEvent; id, connId: tConID; data: pointer = nil; size: uint = 0); virtual;

This virtual method is called every time new sockets event occur.

Parameters

id: Specifies the thread id for which the even applies.
connId: Specifies the connection id of the thread for which the even applies.
event: Specifies the type of event (see unaSocketEvent for details).
data: Data block available from client or server.
size: Size of data.

Properties

	`property onEvent: unaSocksOnEventEvent read f_onEvent write f_onEvent;`
This event is fired every time new sockets event occurs. Refer to .event() method for more information.

Generated by PasDoc 0.12.1 on 2012-10-09