TeamSpeak3_Adapter_FileTransfer Class Reference

Provides low-level methods for file transfer communication with a TeamSpeak 3 Server. More...

Inheritance diagram for TeamSpeak3_Adapter_FileTransfer:

Public Member Functions
	__destruct ()
	The TeamSpeak3_Adapter_FileTransfer destructor. More...
	download ($ftkey, $size, $passthru=FALSE)
	Returns the content of a downloaded file as a TeamSpeak3_Helper_String object. More...
	syn ()
	Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server. More...
	upload ($ftkey, $seek, $data)
	Sends the content of a file to the server. More...
Public Member Functions inherited from TeamSpeak3_Adapter_Abstract
	__construct (array $options)
	The TeamSpeak3_Adapter_Abstract constructor. More...
	__destruct ()
	The TeamSpeak3_Adapter_Abstract destructor. More...
	__sleep ()
	Commit pending data. More...
	__wakeup ()
	Reconnects to the remote server. More...
	getProfiler ()
	Returns the profiler timer used for this connection adapter. More...
	getTransport ()
	Returns the transport object used for this connection adapter. More...
	getTransportHost ()
	Returns the hostname or IPv4 address the underlying TeamSpeak3_Transport_Abstract object is connected to. More...
	getTransportPort ()
	Returns the port number of the server the underlying TeamSpeak3_Transport_Abstract object is connected to. More...

Protected Member Functions
	init ($ftkey)
	Sends a valid file transfer key to the server to initialize the file transfer. More...
	passthru ($size)
	Outputs all remaining data on a TeamSpeak 3 file transfer stream using PHP's fpassthru() function. More...
Protected Member Functions inherited from TeamSpeak3_Adapter_Abstract
	initTransport ($options, $transport="TeamSpeak3_Transport_TCP")
	Loads the transport object object used for the connection adapter and passes a given set of options. More...
	syn ()
	Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server. More...

Detailed Description

Provides low-level methods for file transfer communication with a TeamSpeak 3 Server.

Constructor & Destructor Documentation

__destruct()

__destruct

(

)

The TeamSpeak3_Adapter_FileTransfer destructor.

Returns

void

 {
 if($this->getTransport() instanceof TeamSpeak3_Transport_Abstract && $this->getTransport()->isConnected())
 {
 $this->getTransport()->disconnect();
 }
 }

Member Function Documentation

download()

download	(		$ftkey,
			$size,
			$passthru = FALSE
	)

Returns the content of a downloaded file as a TeamSpeak3_Helper_String object.

Parameters

string	$ftkey
integer	$size
boolean	$passthru

Exceptions

TeamSpeak3_Adapter_FileTransfer_Exception

Returns

TeamSpeak3_Helper_String

 {
 $this->init($ftkey);

 if($passthru)
 {
 return $this->passthru($size);
 }

 $buff = new TeamSpeak3_Helper_String("");
 $size = intval($size);
 $pack = 4096;

 TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferDownloadStarted", $ftkey, count($buff), $size);

 for($seek = 0;$seek < $size;)
 {
 $rest = $size-$seek;
 $pack = $rest < $pack ? $rest : $pack;
 $data = $this->getTransport()->read($rest < $pack ? $rest : $pack);
 $seek = $seek+$pack;

 $buff->append($data);

 TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferDownloadProgress", $ftkey, count($buff), $size);
 }

 $this->getProfiler()->stop();

 TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferDownloadFinished", $ftkey, count($buff), $size);

 if(strlen($buff) != $size)
 {
 throw new TeamSpeak3_Adapter_FileTransfer_Exception("incomplete file download (" . count($buff) . " of " . $size . " bytes)");
 }

 return $buff;
 }

init()

init (   $ftkey )

protected

Sends a valid file transfer key to the server to initialize the file transfer.

Parameters

string

$ftkey

Exceptions

TeamSpeak3_Adapter_FileTransfer_Exception

Returns

void

 {
 if(strlen($ftkey) != 32 && strlen($ftkey) != 16)
 {
 throw new TeamSpeak3_Adapter_FileTransfer_Exception("invalid file transfer key format");
 }

 $this->getProfiler()->start();
 $this->getTransport()->send($ftkey);

 TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferHandshake", $this);
 }

passthru()

passthru (   $size )

protected

Outputs all remaining data on a TeamSpeak 3 file transfer stream using PHP's fpassthru() function.

Parameters

integer

$size

Exceptions

TeamSpeak3_Adapter_FileTransfer_Exception

Returns

void

 {
 $buff_size = fpassthru($this->getTransport()->getStream());

 if($buff_size != $size)
 {
 throw new TeamSpeak3_Adapter_FileTransfer_Exception("incomplete file download (" . intval($buff_size) . " of " . $size . " bytes)");
 }
 }

syn()

syn

(

)

Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server.

Exceptions

TeamSpeak3_Adapter_Exception

Returns

void

 {
 $this->initTransport($this->options);
 $this->transport->setAdapter($this);

 TeamSpeak3_Helper_Profiler::init(spl_object_hash($this));

 TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferConnected", $this);
 }

upload()

upload	(		$ftkey,
			$seek,
			$data
	)

Sends the content of a file to the server.

Parameters

string	$ftkey
integer	$seek
string	$data

Exceptions

TeamSpeak3_Adapter_FileTransfer_Exception

Returns

void

 {
 $this->init($ftkey);

 $size = strlen($data);
 $seek = intval($seek);
 $pack = 4096;

 TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferUploadStarted", $ftkey, $seek, $size);

 for(;$seek < $size;)
 {
 $rest = $size-$seek;
 $pack = $rest < $pack ? $rest : $pack;
 $buff = substr($data, $seek, $pack);
 $seek = $seek+$pack;

 $this->getTransport()->send($buff);

 TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferUploadProgress", $ftkey, $seek, $size);
 }

 $this->getProfiler()->stop();

 TeamSpeak3_Helper_Signal::getInstance()->emit("filetransferUploadFinished", $ftkey, $seek, $size);

 if($seek < $size)
 {
 throw new TeamSpeak3_Adapter_FileTransfer_Exception("incomplete file upload (" . $seek . " of " . $size . " bytes)");
 }
 }

---

The documentation for this class was generated from the following file:

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Adapter/FileTransfer.php