apns-php: ApnsPHP_Push_Server Class Reference

array _getQueue(integer $nQueueKey, integer $nProcess=0)

Returns the queue from the shared memory.

Definition: Server.php:313

void _log(string $sMessage)

Logs a message through the Logger.

Definition: Abstract.php:414

boolean _setQueue(integer $nQueueKey, integer $nProcess=0, array $aQueue=array())

Store the queue into the shared memory.

Definition: Server.php:331

Here is the call graph for this function:

Here is the caller graph for this function:

class_apns_p_h_p___push___server.html#a60de64d75454385b23995437f1d72669

boolean _setQueue ( integer $nQueueKey,

integer $nProcess = 0,

array $aQueue = array()

)

protected

Store the queue into the shared memory.

Parameters: $nQueueKey The key of the queue to store in the shared memory.

$nProcess [optional] The process cardinal number.

$aQueue [optional] The queue to store into shared memory. The default value is an empty array, useful to empty the queue.

Returns: True on success, false otherwise.

Definition at line 331 of file Server.php.

Referenced by _mainLoop(), add(), getErrors(), and getQueue().

332 {

333 if (!is_array($aQueue)) {

334 $aQueue = array();

335 }

336 return shm_put_var($this->_hShm, $nQueueKey + $nProcess, $aQueue);

337 }

Here is the caller graph for this function:

void add ( ApnsPHP_Message $message )

Adds a message to the inter-process message queue.

Messages are added to the queues in a round-robin fashion starting from the first process to the last.

Parameters: $message The message.

Definition at line 209 of file Server.php.

References _getQueue(), and _setQueue().

210 {

211 static $n = 0;

212 if ($n >= $this->_nProcesses) {

213 $n = 0;

214 }

215 sem_acquire($this->_hSem);

216 $aQueue = $this->_getQueue(self::SHM_MESSAGES_QUEUE_KEY_START, $n);

217 $aQueue[] = $message;

218 $this->_setQueue(self::SHM_MESSAGES_QUEUE_KEY_START, $n, $aQueue);

219 sem_release($this->_hSem);

220 $n++;

221 }

array _getQueue(integer $nQueueKey, integer $nProcess=0)

Returns the queue from the shared memory.

Definition: Server.php:313

boolean _setQueue(integer $nQueueKey, integer $nProcess=0, array $aQueue=array())

Store the queue into the shared memory.

Definition: Server.php:331

Here is the call graph for this function:

array getErrors ( boolean $bEmpty = true )

Returns messages not delivered to the end user because one (or more) error occurred.

Parameters: $bEmpty [optional] Empty message container.

Returns: Array of messages not delivered because one or more errors occurred.

Definition at line 255 of file Server.php.

References _getQueue(), and _setQueue().

256 {

257 sem_acquire($this->_hSem);

258 $aRet = $this->_getQueue(self::SHM_ERROR_MESSAGES_QUEUE_KEY);

259 if ($bEmpty) {

260 $this->_setQueue(self::SHM_ERROR_MESSAGES_QUEUE_KEY, 0, array());

261 }

262 sem_release($this->_hSem);

263 return $aRet;

264 }

array _getQueue(integer $nQueueKey, integer $nProcess=0)

Returns the queue from the shared memory.

Definition: Server.php:313

ApnsPHP_Push_Server::$_nProcesses

boolean _setQueue(integer $nQueueKey, integer $nProcess=0, array $aQueue=array())

Store the queue into the shared memory.

Definition: Server.php:331

Here is the call graph for this function:

array getQueue ( boolean $bEmpty = true )

Returns messages in the message queue.

When a message is successful sent or reached the maximum retry time is removed from the message queue and inserted in the Errors container. Use the getErrors() method to retrive messages with delivery error(s).

Parameters: $bEmpty [optional] Empty message queue.

Returns: Array of messages left on the queue.

Definition at line 233 of file Server.php.

References $_nProcesses, _getQueue(), and _setQueue().

234 {

235 $aRet = array();

236 sem_acquire($this->_hSem);

237 for ($i = 0; $i < $this->_nProcesses; $i++) {

238 $aRet = array_merge($aRet, $this->_getQueue(self::SHM_MESSAGES_QUEUE_KEY_START, $i));

239 if ($bEmpty) {

240 $this->_setQueue(self::SHM_MESSAGES_QUEUE_KEY_START, $i);

241 }

242 }

243 sem_release($this->_hSem);

244 return $aRet;

245 }

integer $_nProcesses

The number of processes to start.

Definition: Server.php:41

array _getQueue(integer $nQueueKey, integer $nProcess=0)

Returns the queue from the shared memory.

Definition: Server.php:313

boolean _setQueue(integer $nQueueKey, integer $nProcess=0, array $aQueue=array())

Store the queue into the shared memory.

Definition: Server.php:331

Here is the call graph for this function:

void onChildExited ( )

Waits until a forked process has exited and decreases the current running process number.

Definition at line 109 of file Server.php.

110 {

111 while (pcntl_waitpid(-1, $nStatus, WNOHANG) > 0) {

112 $this->_nRunningProcesses--;

113 }

114 }

void onShutdown ( )

When the parent process exits, cleans shared memory and semaphore.

This is called using 'register_shutdown_function' pattern.

See Also: http://php.net/register_shutdown_function

Definition at line 146 of file Server.php.

References ApnsPHP_Abstract::_log().

147 {

148 if (posix_getpid() == $this->_nParentPid) {

149 $this->_log('INFO: Parent shutdown, cleaning memory...');

150 @shm_remove($this->_hShm) && @shm_detach($this->_hShm);

151 @sem_remove($this->_hSem);

152 }

153 }

void _log(string $sMessage)

Logs a message through the Logger.

Definition: Abstract.php:414

Here is the call graph for this function:

class_apns_p_h_p___abstract.html#a6e9fdc68fece1907733a1e76f667622f

void onSignal ( integer $nSignal )

When a child (not the parent) receive a signal of type TERM, QUIT or INT exits from the current process and decreases the current running process number.

Parameters: $nSignal Signal number.

Definition at line 122 of file Server.php.

References ApnsPHP_Abstract::_log().

123 {

124 switch ($nSignal) {

125 case SIGTERM:

126 case SIGQUIT:

127 case SIGINT:

128 if (($nPid = posix_getpid()) != $this->_nParentPid) {

129 $this->_log("INFO: Child $nPid received signal #{$nSignal}, shutdown...");

130 $this->_nRunningProcesses--;

131 exit(0);

132 }

133 break;

134 default:

135 $this->_log("INFO: Ignored signal #{$nSignal}.");

136 break;

137 }

138 }

ApnsPHP_Push_Server::$_nProcesses

void _log(string $sMessage)

Logs a message through the Logger.

Definition: Abstract.php:414

Here is the call graph for this function:

class_apns_p_h_p___abstract.html#a6e9fdc68fece1907733a1e76f667622f

boolean run ( )

Checks if the server is running and calls signal handlers for pending signals.

Example:

while ($Server->run()) {

// do somethings...

usleep(200000);

}

Returns: True if the server is running.

Definition at line 99 of file Server.php.

100 {

101 pcntl_signal_dispatch();

102 return $this->_nRunningProcesses > 0;

103 }

void setProcesses ( integer $nProcesses )

Set the total processes to start, default is 3.

Parameters: $nProcesses Processes to start up.

Definition at line 160 of file Server.php.

161 {

162 $nProcesses = (int)$nProcesses;

163 if ($nProcesses <= 0) {

164 return;

165 }

166 $this->_nProcesses = $nProcesses;

167 }

void start ( )

Starts the server forking all processes and return immediately.

Every forked process is connected to Apple Push Notification Service on start and enter on the main loop.

Definition at line 175 of file Server.php.

References $_nProcesses, ApnsPHP_Abstract::_log(), and _mainLoop().

176 {

177 for ($i = 0; $i < $this->_nProcesses; $i++) {

178 $this->_nCurrentProcess = $i;

179 $this->_aPids[$i] = $nPid = pcntl_fork();

180 if ($nPid == -1) {

181 $this->_log('WARNING: Could not fork');

182 } else if ($nPid > 0) {

183 // Parent process

184 $this->_log("INFO: Forked process PID {$nPid}");

185 $this->_nRunningProcesses++;

186 } else {

187 // Child process

188 try {

189 parent::connect();

190 } catch (ApnsPHP_Exception $e) {

191 $this->_log('ERROR: ' . $e->getMessage() . ', exiting...');

192 exit(1);

193 }

194 $this->_mainLoop();

195 parent::disconnect();

196 exit(0);

197 }

198 }

199 }

integer $_nProcesses

The number of processes to start.

Definition: Server.php:41

ApnsPHP_Exception

Exception class.

Definition: Exception.php:25