CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($waObj, $parent)
  __get ($name)
  __set ($name, $value)
  addListener ($address)
  addUrlRedirect ($address, $host, $port)
  configAccessControl ()
  getAccessControl ()
  getAllowKeepAlive ()
  getAllowLargeIncomingData ()
  getHttpBodyMaxSize ()
  getHttpHeadersMaxSize ()
  getLogHost ()
  getLogLevel ()
  getLogType ()
  getMaxAuthErrors ()
  getMaxConnThreads ()
  getMaxErrors ()
  getMinConnThreads ()
  getPath ()
  getSessionActivityTimeout ()
  getSessionIdleTimeout ()
  getSessionObj ()
  getUploadMaxSize ()
  getWebadminObj ()
  listListeners ()
  listUrlRedirects ()
  removeListener ($address)
  removeUrlRedirect ($address)
  reset ()
  save ()
  setAllowKeepAlive ($value)
  setAllowLargeIncomingData ($value)
  setHttpBodyMaxSize ($value)
  setHttpHeadersMaxSize ($value)
  setLogHost ($value)
  setLogLevel ($value)
  setLogType ($value)
  setMaxAuthErrors ($value)
  setMaxConnThreads ($value)
  setMaxErrors ($value)
  setMinConnThreads ($value)
  setPath ($value)
  setSessionActivityTimeout ($value)
  setSessionIdleTimeout ($value)
  setUploadMaxSize ($value)
  start ()
  stop ()
  updateListener ($address)
  updateUrlRedirect ($address, $newHost, $newPort)

Member Function Documentation

Webadmin::__get ( name  ) 

Get member.

member

description

maxConnThreads

the maximum number of threads involved in I/O for the Webadmin service

maxErrors

the maximum number of protocol errors after which the connection is terminated

maxAuthErrors

the maximum number of authentication errors after which the connection is terminated

sessionIdleTimeout

the time interval after which an idle session is terminated

sessionActivityTimeout

the maximum time interval after which a Webadmin session is terminated even if activity exists

allowKeepAlive

permanent connections

allowLargeIncomingData

the data receiving to be allowed after the session is terminated

httpHeadersMaxSize

the maximum allowed size for received HTTP headers

httpBodyMaxSize

the maximum allowed size for incoming HTTP body

uploadMaxSize

the maximum allowed size for incoming upload data

path

the Webadmin's directory path

logLevel

the log level for the Webadmin service

logHost

the address of the host that offers log services

logType

the log type for the Webadmin service

Webadmin::__set ( name,
value  
)

Set member.

member

description

maxConnThreads

the maximum number of threads involved in I/O for the Webadmin service

maxErrors

the maximum number of protocol errors after which the connection is terminated

maxAuthErrors

the maximum number of authentication errors after which the connection is terminated

sessionIdleTimeout

the time interval after which an idle session is terminated

sessionActivityTimeout

the maximum time interval after which a Webadmin session is terminated even if activity exists

allowKeepAlive

permanent connections

allowLargeIncomingData

the data receiving to be allowed after the session is terminated

httpHeadersMaxSize

the maximum allowed size for received HTTP headers

httpBodyMaxSize

the maximum allowed size for incoming HTTP body

uploadMaxSize

the maximum allowed size for incoming upload data

path

the Webadmin's directory path

logLevel

the log level for the Webadmin service

logHost

the address of the host that offers log services

logType

the log type for the Webadmin service

Webadmin::addListener ( address  ) 

This function adds a listener to this service

Returns:
bool
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)
Webadmin::addUrlRedirect ( address,
host,
port  
)

adds an Webadmin URL redirect

Returns:
bool
Parameters:
$address  string the address
$host  string the host
$port  int port number for the host
Webadmin::configAccessControl (  ) 

This function returns an access control object for this service

Returns:
object AccessControl
Webadmin::getAccessControl (  ) 

This function returns an access control object for the Webadmin service

Returns:
AccessControl
Webadmin::listListeners (  ) 

This function lists the listeners for this service

Returns:
array
Webadmin::listUrlRedirects (  ) 

list all URL redirects

Returns:
array
Webadmin::removeListener ( address  ) 

This function removes a listener from this service

Returns:
bool
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)
Webadmin::removeUrlRedirect ( address  ) 

removes an Webadmin URL redirect

Returns:
bool
Parameters:
$address  string the address
Webadmin::start (  ) 

This function starts the Webadmin service

Returns:
bool
Webadmin::stop (  ) 

This function stops the Webadmin service

Returns:
bool
Webadmin::updateListener ( address  ) 

This function updates a listener of this service

Returns:
object Listener
Parameters:
$address  string the listener address (ex: 127.0.0.1:25)
Webadmin::updateUrlRedirect ( address,
newHost,
newPort  
)

updates an Webadmin URL redirect

Returns:
bool
Parameters:
$address  string the address
$newHost  string the new host
$newPort  string the new port