Inheritance diagram for ilBMFTransport_TCP:

Collaboration diagram for ilBMFTransport_TCP:

Public Member Functions
	ilBMFTransport_TCP ($url, $encoding=SOAP_DEFAULT_ENCODING)
	Constructor. More...

	_socket_ping ()

	send ($msg, $options=NULL)
	Sends and receives SOAP data. More...

	_validateUrl ()
	Validates the url data passed to the constructor. More...

Public Member Functions inherited from ilBMFBase_Object
	ilBMFBase_Object ($faultcode='Client')
	Constructor. More...

&	_raiseSoapFault ($str, $detail='', $actorURI='', $code=null, $mode=null, $options=null, $skipmsg=false)
	Raises a SOAP error. More...

	__isfault ()

&	__getfault ()

	_debug ($string)
	Adds a string to the debug data. More...

Public Member Functions inherited from PEAR
	PEAR ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

&	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Data Fields
	$headers = array()

	$urlparts = null

	$url = ''

	$incoming_payload = ''

	$_userAgent = SOAP_LIBRARY_NAME

	$encoding = SOAP_DEFAULT_ENCODING

	$result_encoding = 'UTF-8'

	$result_content_type

	$socket = null
	socket More...

Data Fields inherited from ilBMFBase_Object
	$_debug_flag = false
	Store debugging information in $_debug_data? More...

	$_debug_data = ''
	String containing debugging information if $_debug_flag is true. More...

	$_encodings = array('ISO-8859-1', 'US-ASCII', 'UTF-8')
	Supported encodings, limited by XML extension. More...

	$_myfaultcode = ''
	Fault code. More...

	$fault = null
	Recent PEAR_Error object. More...

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Detailed Description

Definition at line 33 of file class.ilBMFTransport_TCP.php.

Member Function Documentation

◆ _socket_ping()

ilBMFTransport_TCP::_socket_ping ( )

Definition at line 65 of file class.ilBMFTransport_TCP.php.

References $result.

Referenced by send().

     {
         // XXX how do we restart after socket_shutdown?
         //if (!$this->socket) {
             // Create socket resource.
             $this->socket = @socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
             if ($this->socket < 0) {
                 return 0;
             }
 
             // Connect.
             $result = socket_connect($this->socket, $this->urlparts['host'],
                                      $this->urlparts['port']);
             if ($result < 0) {
                 return 0;
             }
         //}
         return 1;
     }

Here is the caller graph for this function:

◆ _validateUrl()

ilBMFTransport_TCP::_validateUrl ( )

Validates the url data passed to the constructor.

Returns: boolean private

Definition at line 142 of file class.ilBMFTransport_TCP.php.

References ilBMFBase_Object\_raiseSoapFault().

Referenced by send().

     {
         if (!is_array($this->urlparts) ) {
             $this->_raiseSoapFault("Unable to parse URL $url");
             return false;
         }
         if (!isset($this->urlparts['host'])) {
             $this->_raiseSoapFault("No host in URL $url");
             return false;
         }
         if (!isset($this->urlparts['path']) || !$this->urlparts['path']) {
             $this->urlparts['path'] = '/';
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ilBMFTransport_TCP()

ilBMFTransport_TCP::ilBMFTransport_TCP	(	$url,
		$encoding = `SOAP_DEFAULT_ENCODING`
	)

Constructor.

Parameters

string $url HTTP url to SOAP endpoint.

public

Definition at line 57 of file class.ilBMFTransport_TCP.php.

References $encoding, and $url.

     {
         parent::ilBMFBase_Object('TCP');
         $this->urlparts = @parse_url($url);
         $this->url = $url;
         $this->encoding = $encoding;
     }

◆ send()

ilBMFTransport_TCP::send	(	$msg,
		$options = `NULL`
	)

Sends and receives SOAP data.

Parameters

string	$msg	Outgoing POST data.
string	$action	SOAP Action header data.

Returns: string|ilBMFFault public

Definition at line 94 of file class.ilBMFTransport_TCP.php.

References ilBMFBase_Object\$fault, $incoming_payload, ilBMFBase_Object\_raiseSoapFault(), _socket_ping(), and _validateUrl().

     {
         $this->incoming_payload = '';
         $this->outgoing_payload = $msg;
         if (!$this->_validateUrl()) {
             return $this->fault;
         }
 
         // Check for TCP scheme.
         if (strcasecmp($this->urlparts['scheme'], 'TCP') == 0) {
             // Check connection.
             if (!$this->_socket_ping()) {
                 return $this->_raiseSoapFault('Error connecting to ' . $this->url . '; reason: ' . socket_strerror(socket_last_error($this->socket)));
             }
 
             // Write to the socket.
             if (!@socket_write($this->socket, $this->outgoing_payload,
                                strlen($this->outgoing_payload))) {
                 return $this->_raiseSoapFault('Error sending data to ' . $this->url . '; reason: ' . socket_strerror(socket_last_error($this->socket)));
             }
 
             // Shutdown writing.
             if(!socket_shutdown($this->socket, 1)) {
                 return $this->_raiseSoapFault('Cannot change socket mode to read.');
             }
 
             // Read everything we can.
             while ($buf = @socket_read($this->socket, 1024, PHP_BINARY_READ)) {
                 $this->incoming_payload .= $buf;
             }
 
             // Return payload or die.
             if ($this->incoming_payload) {
                 return $this->incoming_payload;
             }
 
             return $this->_raiseSoapFault('Error reveiving data from ' . $this->url);
         }
 
         return $this->_raiseSoapFault('Invalid url scheme ' . $this->url);
     }