phpBB API Documentation
Class

queue

class queue

handling email and jabber queue

Properties

$data
$queue_data
$package_size
$cache_file
$eol

Methods

queue()

constructor

init($object, $package_size)

Init a queue object

put($object, $scope)

Put object in queue

lock()

Obtains exclusive lock on queue cache file.

unlock($lock_fp)

Releases lock on queue cache file, using resource obtained from lock()

process()

Process queue Using lock file

save()

Save queue

Details

at line 642
public queue()

constructor

at line 657
public init($object, $package_size)

Init a queue object

Parameters

$object
$package_size

at line 667
public put($object, $scope)

Put object in queue

Parameters

$object
$scope

at line 676
public lock()

Obtains exclusive lock on queue cache file.

Returns resource representing the lock

at line 719
public unlock($lock_fp)

Releases lock on queue cache file, using resource obtained from lock()

Parameters

$lock_fp

at line 734
public process()

Process queue Using lock file

at line 900
public save()

Save queue