PHP Class dropr_Server_Storage_Abstract, dropr

Copyright (c) 2007 - 2008 by the dropr project https://www.dropr.org/ All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of dropr nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Author: Soenke Ruempler ([email protected])
Author: Boris Erdmann ([email protected])
Mostrar archivo Open project: s0enke/dropr Class Usage Examples

Public Methods

Method Description
countProcessedMessages ( $channel = 'common' )
countQueuedMessages ( $channel = 'common' )
factory ( string $type, string $dsn ) : dropr_Server_Storage_Abstract Create a server storage instance
getMessages ( $channel = 'common', $limit = null ) : array
getProcessedChannels ( )
getQueuedChannels ( )
getType ( )
pollProcessed ( $messageId ) : boolean
put ( dropr_Server_Message $message )
setProcessed ( dropr_Server_Message $message ) Sets a message to processed state - the implementation must move it out from the list of active messages to it's not in list of getMessages anymore
wipeSentMessages ( $olderThanMinutes, $channel = 'common' )

Method Details

countProcessedMessages() abstract public method

abstract public countProcessedMessages ( $channel = 'common' )

countQueuedMessages() abstract public method

abstract public countQueuedMessages ( $channel = 'common' )

factory() public static method

Create a server storage instance
public static factory ( string $type, string $dsn ) : dropr_Server_Storage_Abstract
$type string
$dsn string
return dropr_Server_Storage_Abstract

getMessages() abstract public method

abstract public getMessages ( $channel = 'common', $limit = null ) : array
return array

getProcessedChannels() abstract public method

abstract public getProcessedChannels ( )

getQueuedChannels() abstract public method

abstract public getQueuedChannels ( )

getType() abstract public method

abstract public getType ( )

pollProcessed() abstract public method

abstract public pollProcessed ( $messageId ) : boolean
return boolean

put() abstract public method

abstract public put ( dropr_Server_Message $message )
$message dropr_Server_Message

setProcessed() abstract public method

Sets a message to processed state - the implementation must move it out from the list of active messages to it's not in list of getMessages anymore
abstract public setProcessed ( dropr_Server_Message $message )
$message dropr_Server_Message

wipeSentMessages() abstract public method

abstract public wipeSentMessages ( $olderThanMinutes, $channel = 'common' )