Public Member Functions |
|
| __construct ($listenerObj, $parent) | |
| __get ($varName) | |
| __set ($varName, $varValue) | |
| addAllowRule ($ipRangeNetwork, $enable="yes", $priority=null) | |
| addDenyRule ($ipRangeNetwork, $enable="yes", $priority=null) | |
| configSslControl () | |
| getListenerObj () | |
| getRulesObj () | |
| getSessionObj () | |
| listAllowRules () | |
| listDenyRules () | |
| removeAllowRule ($ipRangeNetwork) | |
| removeDenyRule ($ipRangeNetwork) | |
| save () | |
| saveRules () | |
| updateAllowRule ($ipRangeNetwork) | |
| updateDenyRule ($ipRangeNetwork, $enable=null, $priority=null) | |
Member Function Documentation
| Listener::__get | ( | $ | varName | ) |
Get member.
|
member |
description |
|---|---|
|
address |
the listener's address |
|
enable |
the enabled/disabled status of the listener |
|
maxConnections |
the maximum number of connections |
|
timeInterval |
the time interval |
|
maxIntervalConnections |
the maximum number of connections in a time interval |
|
peerMaxConnections |
the maximum number of connections from a single host |
|
peerTimeInterval |
the time interval - single host |
|
peerMaxIntervalConnections |
the maximum number of connections in a time interval - single host |
|
idleTimeout |
the inactivity timeout |
|
sslEnable |
SSL as enabled/disabled on the listener |
|
listenerDomain |
the domain of the listener |
| Listener::__set | ( | $ | varName, | |
| $ | varValue | |||
| ) |
Set member.
|
member |
description |
|---|---|
|
address |
the listener's address |
|
enable |
the enabled/disabled status of the listener |
|
maxConnections |
the maximum number of connections |
|
timeInterval |
the time interval |
|
maxIntervalConnections |
the maximum number of connections in a time interval |
|
peerMaxConnections |
the maximum number of connections from a single host |
|
peerTimeInterval |
the time interval - single host |
|
peerMaxIntervalConnections |
the maximum number of connections in a time interval - single host |
|
idleTimeout |
the inactivity timeout |
|
sslEnable |
SSL as enabled/disabled on the listener |
|
listenerDomain |
the domain of the listener |
| Listener::addAllowRule | ( | $ | ipRangeNetwork, | |
| $ | enable = "yes", |
|||
| $ | priority = null |
|||
| ) |
Adds an allow rule
- Returns:
- bool
- Parameters:
-
$ipRangeNetwork string IP range or network/mask (ex: 1.2.3.4-1.2.3.5 or 1.2.3.0/255.255.255.0) $enable string enables rule (optional default: yes) $priority int rule priority (optional default: auto)
| Listener::addDenyRule | ( | $ | ipRangeNetwork, | |
| $ | enable = "yes", |
|||
| $ | priority = null |
|||
| ) |
Adds a deny rule
- Returns:
- bool
- Parameters:
-
$ipRangeNetwork string IP range or network/mask (ex: 1.2.3.4-1.2.3.5 or 1.2.3.0/255.255.255.0) $enable string (optional default: yes) $priority int rule priority (optional default: auto)
| Listener::configSslControl | ( | ) |
this method returns an object to configure SSL control for the listener
- Returns:
- object SslControl
| Listener::listAllowRules | ( | ) |
returns an array with all the allow rules
- Returns:
- array
| Listener::listDenyRules | ( | ) |
returns an array with all the deny rules
- Returns:
- array
| Listener::removeAllowRule | ( | $ | ipRangeNetwork | ) |
Removes an allow rule
- Returns:
- bool
- Parameters:
-
$ipRangeNetwork string IP range or network/mask (ex: 1.2.3.4-1.2.3.5 or 1.2.3.0/255.255.255.0)
| Listener::removeDenyRule | ( | $ | ipRangeNetwork | ) |
Removes a deny rule
- Returns:
- bool
- Parameters:
-
$ipRangeNetwork string IP range or network/mask (ex: 1.2.3.4-1.2.3.5 or 1.2.3.0/255.255.255.0)
| Listener::save | ( | ) |
This method must be called if one of the members has been changed
- Returns:
- bool
| Listener::updateAllowRule | ( | $ | ipRangeNetwork | ) |
This method returns an object with allow rule loaded
- Returns:
- object AllowRule
- Parameters:
-
$ipRangeNetwork string IP range or network/mask (ex: 1.2.3.4-1.2.3.5 or 1.2.3.0/255.255.255.0)
| Listener::updateDenyRule | ( | $ | ipRangeNetwork, | |
| $ | enable = null, |
|||
| $ | priority = null |
|||
| ) |
This method updates a deny rule
- Returns:
- Parameters:
-
$ipRangeNetwork string IP range or network/mask (ex: 1.2.3.4-1.2.3.5 or 1.2.3.0/255.255.255.0) $enable string sets the enable/disabled status of the rule $priority int sets the rule priority