ZEND INTERNAL DO NOT PUBLISH

Zend Session Clustering - PHP API

Table of Contents

Predefined Global Constants

ZEND_SC_STATUS_OFF
Daemon is not running
ZEND_SC_STATUS_STANDBY
Daemon is in standby mode
ZEND_SC_STATUS_OK
Daemon is in working mode
ZEND_SC_STATUS_INTERNAL_ERROR
Daemon has an internal error and is not working properly
ZEND_SC_STATUS_SHUTDOWN_IN_PROCESS
Daemon has started to shutdown
ZEND_SC_STATUS_SHUTDOWN_FAILED
Daemon shutdown process failed
ZEND_SC_NO_ERROR
Event Type: custom event
ZEND_SC_NETWORK_ERROR
Event Type: custom event
ZEND_SC_TIMEOUT_ERROR
Event Type: custom event
ZEND_SC_UNKNOWN_ERROR
Event Type: custom event

PHP Functions

zend_sc_get_statistics

Gets the statistics of the Session Clustering module

Available since version 4.0

Description

array zend_sc_get_statistics (void)

Return Value

The function returns an array of statistics

zend_sc_get_daemon_status

Gets the status of the Session Clustering daemon

Available since version 4.0

Description

int zend_sc_get_daemon_status (void)

Return Value

1. ZEND_SC_STATUS_OFF [integer] <br> 2. ZEND_SC_STATUS_STANDBY [integer] <br> 3. ZEND_SC_STATUS_OK [integer] <br> 4. ZEND_SC_STATUS_SHUTDOWN_IN_PROCESS [integer] <br> 5. ZEND_SC_STATUS_SHUTDOWN_FAILED [integer] <br>

zend_sc_graceful_shutdown

Orders the SC daemon to graceful shutdown

Available since version 4.0

Description

boolean zend_sc_graceful_shutdown (void)

Return Value

true if successful, false otherwise

zend_sc_get_last_error

Gets the status of the Session Clustering module

Available since version 4.0

Description

string zend_sc_get_last_error (void)

Return Value

Returns the last error string that the SC daemon has

zend_sc_get_last_error_code

Returns the last error code that the SC daemon has

Available since version 4.0

Description

int zend_sc_get_last_error_code (void)

Return Value

1. ZEND_SC_NO_ERROR [integer] <br> 2. ZEND_SC_NETWORK_ERROR [integer] <br> 3. ZEND_SC_TIMEOUT_ERROR [integer] <br> 4. ZEND_SC_UNKNOWN_ERROR [integer] <br>

zend_sc_reset_last_error

Gets the status of the Session Clustering module

Available since version 4.0

Description

void zend_sc_reset_last_error (void)

zend_sc_reload_configuration

Gets the status of the Session Clustering module

Available since version 4.0

Description

array zend_sc_reload_configuration (void)

Return Value

Orders the SC daemon to reload the configruation files