com_message_pump(3) [php man page]

COM_MESSAGE_PUMP(3)							 1						       COM_MESSAGE_PUMP(3)

com_message_pump - Process COM messages, sleeping for up to timeoutms milliseconds

SYNOPSIS

       bool com_message_pump ([int  $timeoutms])

DESCRIPTION

	This function will sleep for up to $timeoutms milliseconds, or until a message arrives in the queue.

	The  purpose  of this function is to route COM calls between apartments and handle various synchronization issues. This allows your script
       to wait efficiently for events to be triggered, while still handling other events or running other code in the background. You  should  use
       it in a loop, as demonstrated by the example in the com_event_sink(3) function, until you are finished using event bound COM objects.

PARAMETERS

	      o $timeoutms
		-  The	timeout,  in  milliseconds.  If you do not specify a value for $timeoutms, then 0 will be assumed. A 0 value means that no
		waiting will be performed; if there are messages pending they will be dispatched as before; if there are no messages pending,  the
		function will return FALSE immediately without sleeping.

RETURN VALUES

	If a message or messages arrives before the timeout, they will be dispatched, and the function will return TRUE. If the timeout occurs and
       no messages were processed, the return value will be FALSE.

PHP Documentation Group 												       COM_MESSAGE_PUMP(3)

COM_EVENT_SINK(3)							 1							 COM_EVENT_SINK(3)

com_event_sink - Connect events from a COM object to a PHP object

SYNOPSIS

       bool com_event_sink (variant  $comobject, object  $sinkobject, [mixed  $sinkinterface])

DESCRIPTION

	Instructs COM to sink events generated by $comobject into the PHP object $sinkobject.

	Be  careful how you use this feature; if you are doing something similar to the example below, then it doesn't really make sense to run it
       in a web server context.

PARAMETERS

	      o $comobject
		-

	      o $sinkobject
		-$sinkobject should be an instance of a class  with  methods  named  after  those  of  the  desired  dispinterface;  you  may  use
		com_print_typeinfo(3) to help generate a template class for this purpose.

	      o $sinkinterface
		-  PHP	will  attempt  to  use the default dispinterface type specified by the typelibrary associated with $comobject, but you may
		override this choice by setting $sinkinterface to the name of the dispinterface that you want to use.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      COM event sink example

	      <?php
	      class IEEventSinker {
		  var $terminated = false;

		 function ProgressChange($progress, $progressmax) {
		    echo "Download progress: $progress / $progressmax
";
		  }

		  function DocumentComplete(&$dom, $url) {
		    echo "Document $url complete
";
		  }

		  function OnQuit() {
		    echo "Quit!
";
		    $this->terminated = true;
		  }
	      }
	      $ie = new COM("InternetExplorer.Application");
	      // note that you don't need the & for PHP 5!
	      $sink = new IEEventSinker();
	      com_event_sink($ie, $sink, "DWebBrowserEvents2");
	      $ie->Visible = true;
	      $ie->Navigate("http://www.example.org");
	      while(!$sink->terminated) {
		com_message_pump(4000);
	      }
	      $ie = null;
	      ?>

SEE ALSO

       com_print_typeinfo(3), com_message_pump(3).

PHP Documentation Group 													 COM_EVENT_SINK(3)