Class Shift8_Queue_Processor

Description
Description | Descendents | Methods (details)

Abstract class defining a Shift8 Queue Processor.

The Queue processor is responsible for inserting, retrieving and updating the Shift8 Queue. This has been implemented as a seperate mechanism to allow the Queue to be implemented into various data structures such as Databases (mysql, postgresql, oracle etc), flat based files, or whatever the user requires, whithout having to interfere with the internals of the Shift8 library

  • author: Paris Stamatopoulos
  • version: 0.1.1
  • abstract:
  • usedby: Shift8

Located in /Queue/Processor.php (line 30) 


	
			




	
	

		
Direct descendents

		

			Description |
			Descendents
			|															Methods (details)
							
								

		

			

				

					Class
					Description
				

								

					Shift8_Queue_Processor_Mysql
					
											Provides a simple queuing mechanism using Mysql to store the actual Shift8 Queue.
										
				

							

		

	




	
	

		
Method Summary

		

			Description |
							Descendents |
												Methods (details)
		

		
			
			

																																				
												

											integer
										insert
											(Shift8_Queue_Item $item)
									

																

											Shift8_Queue_Item[]
										queue
										()
									

																

											Shift8_Event|Shift8_Event[]
										retrieveResponse
											(integer $queue_id)
									

																

											boolean
										update
											(Shift8_Queue_Item $item)
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
							Descendents |
																Methods (details)
						
		

		

			




	
	

		insert (line 38)
	
 
	
	

Function responsible for inserting a new queue item to the Shift8 Queue

	
    
				
  • return: The number of the queue position for this command
    • 
				
  • abstract: 
    • 
				
  • access: public
    • 
			

	
	

		integer
		
			insert
		
					(Shift8_Queue_Item $item)
			

	
			
		
			
			

		
Redefined in descendants as:

		
	




	
	

		queue (line 54)
	
 
	
	

Retrieves the unprocessed commands in the queue

	
    
				
  • abstract: 
    • 
				
  • access: public
    • 
			

	
	

		Shift8_Queue_Item[]
		
			queue
		
				()
			

	
		
			
			

		
Redefined in descendants as:

		
	




	
	

		retrieveResponse (line 63)
	
 
	
	

Retrieves the response of a processed command based on the queue id

	
    
				
  • abstract: 
    • 
				
  • access: public
    • 
			

	
	

		Shift8_Event|Shift8_Event[]
		
			retrieveResponse
		
					(integer $queue_id)
			

	
			
    
					
  • 
				integer
				$queue_id: The queue id to retrieve information for			
    • 
				

		
			
			

		
Redefined in descendants as:

		
	




	
	

		update (line 47)
	
 
	
	

Function responsible for updating an existing queued command with command results

	
    
				
  • abstract: 
    • 
				
  • access: public
    • 
			

	
	

		boolean
		
			update
		
					(Shift8_Queue_Item $item)
			

	
			
		
			
			

		
Redefined in descendants as:

		
	

						
		

	



	

		Documentation generated on Mon, 28 Dec 2009 17:42:49 +0200 by phpDocumentor 1.4.3