Home Units Hierarchy Routines All identifiers

Class unavclIPClient

Description

Hierarchy

Fields

Methods

Properties

Unit

unaVC_socks

Declaration

type unavclIPClient = class(unavclInOutIpPipe)

Description

IP Client: connects to remote server, sends and receives audio stream over TCP/IP network.

Usage: set host, proto and port properties to specify the remote host. Set active to true or call the open() method to initiate the connection.

Example: refer to vcTalkNow demo, with ip_client it is possible to send compressed audio stream over network and receive audio stream from remote server for playback.

Hierarchy

tComponent
unavclInOutPipe
unavclInOutIpPipe
unavclIPClient

Overview

Methods

	`function doSendPacket(connId: tConID; cmd: uint; out asynch: bool; data: pointer = nil; len: uint = 0; timeout: tTimeout = 81): tunaSendResult; override;`
	`function doWrite(data: pointer; len: uint; provider: pointer = nil): uint; override;`
	`function handleSocketEvent(event: unaSocketEvent; id, connId: tConID; data: pointer; len: uint): bool; override;`
	`function initSocksThread(): tConID; override;`
	`function isActive(): bool; override;`
	`function onNewPacket(cmd: uint; data: pointer; len: uint; connId: tConID; worker: uint): bool; override;`
	`procedure AfterConstruction(); override;`
	`procedure BeforeDestruction(); override;`
	`procedure sendGoodbye(connId: tConID); override;`

Properties

	`property bindToPort;`
	`property clientConnId: tConID read f_connId;`
	`property host;`
	`property isConnected: bool read f_isConnected;`
	`property onClientConnect: tunavclConnectEvent read f_onClientConnect write f_onClientConnect;`
	`property onClientDisconnect: tunavclConnectEvent read f_onClientDisconnect write f_onClientDisconnect;`
	`property pingInterval: uint32 read f_pingInterval write f_pingInterval default 0;`

Description

Methods

	`function doSendPacket(connId: tConID; cmd: uint; out asynch: bool; data: pointer = nil; len: uint = 0; timeout: tTimeout = 81): tunaSendResult; override;`
Sends a packet to server.

	`function doWrite(data: pointer; len: uint; provider: pointer = nil): uint; override;`
Writes data into the TCP/IP stream to be sent to server.

	`function handleSocketEvent(event: unaSocketEvent; id, connId: tConID; data: pointer; len: uint): bool; override;`

	`function initSocksThread(): tConID; override;`

	`function isActive(): bool; override;`
Returns active state of IP Client.

	`function onNewPacket(cmd: uint; data: pointer; len: uint; connId: tConID; worker: uint): bool; override;`

	`procedure AfterConstruction(); override;`

	`procedure BeforeDestruction(); override;`

	`procedure sendGoodbye(connId: tConID); override;`
Sends goodbye packet to the server.

Properties

	`property bindToPort;`
Local port number client should bind to. 0 means client will let system to select any free port.

	`property clientConnId: tConID read f_connId;`
Client socket connection Id.

	`property host;`
Remote host DNS name/IP address to connect to.

	`property isConnected: bool read f_isConnected;`
Returns true if client socket is connected to remote host

property onClientConnect: tunavclConnectEvent read f_onClientConnect write f_onClientConnect;

Triggers when client has been connected to the server.

NOTE: VCL is NOT multi-threading safe, and you should avoid using VCL routines and classes in this event.

property onClientDisconnect: tunavclConnectEvent read f_onClientDisconnect write f_onClientDisconnect;

Triggers when client has been disconnected from the server.

NOTE: VCL is NOT multi-threading safe, and you should avoid using VCL routines and classes in this event.

	`property pingInterval: uint32 read f_pingInterval write f_pingInterval default 0;`
Specifies the inteval in milliseconds the client should send a dummy "ping" packet to the server. Use this with UDP client only which do not send data to server, so server will not disconnect the client due to timeout. Default value is 0, means ping is disabled.

Generated by PasDoc 0.12.1 on 2012-10-09