List of all members.

Public Member Functions
	__construct ($cliObj, $parent)
	__get ($name)
	__set ($name, $value)
	addListener ($address)
	configAccessControl ()
	getCliObj ()
	getLogHost ()
	getLogLevel ()
	getLogType ()
	getMaxAuthCommands ()
	getMaxAuthErrors ()
	getMaxConnThreads ()
	getMaxErrors ()
	getMinConnThreads ()
	getSessionObj ()
	listListeners ()
	removeListener ($address)
	reset ()
	save ()
	setLogHost ($value)
	setLogLevel ($value)
	setLogType ($value)
	setMaxAuthCommands ($value)
	setMaxAuthErrors ($value)
	setMaxConnThreads ($value)
	setMaxErrors ($value)
	setMinConnThreads ($value)
	start ()
	stop ()
	updateListener ($address)

---

Member Function Documentation

Cli::__get

(

$

name

)

Get member.

member	description
maxConnThreads	the maximum number of threads involved in I/O for the CLI service
minConnThreads	the minimum number of threads involved in I/O for the CLI 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
maxAuthCommands	the maximum number of commands the CLI service performs before the user logs in
logLevel	the log level for the CLI service
logHost	the address of the host that offers log services
logType	the log type for the CLI service

Cli::__set	(	$	name,
		$	value
	)

Set member.

member	description
maxConnThreads	the maximum number of threads involved in I/O for the CLI service
minConnThreads	the minimum number of threads involved in I/O for the CLI 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
maxAuthCommands	the maximum number of commands the CLI service performs before the user logs in
logLevel	the log level for the CLI service
logHost	the address of the host that offers log services
logType	the log type for the CLI service

Cli::addListener

(

$

address

)

This function adds a listener to this service

Returns:

bool

Parameters:

$address

int the listener address (ex: 127.0.0.1:25)

Cli::configAccessControl

(

)

This function returns an access control object for this service

Returns:

object AccessControl

Cli::getLogHost

(

)

This function returns the host which handles the logging (if the log type is not local)

Returns:

String

Cli::getLogLevel

(

)

This function returns the log level for this service

Returns:

int

Cli::getLogType

(

)

This function returns the log for this service

Returns:

String Expected values are: "internal", "system" or "remote"

Cli::getMaxAuthCommands

(

)

This function returns 1 if secure connections (which start with STARTTLS) are allowed for this service and 0 otherwise

Returns:

int

Cli::getMaxAuthErrors

(

)

This function returns the maximum number of authentication errors after which the connection is terminated

Returns:

int

Cli::getMaxConnThreads

(

)

This function returns the maximum number of threads involved in I/O for this service

Returns:

int

Cli::getMaxErrors

(

)

This function returns the maximum number of protocol errors after which the connection is terminated

Returns:

int

Cli::getMinConnThreads

(

)

This function returns the minimum number of threads involved in I/O for this service

Returns:

int

Cli::listListeners

(

)

This function lists the listeners for this service

Returns:

array

Cli::removeListener

(

$

address

)

This function removes a listener from this service

Returns:

bool

Parameters:

$address

int the listener address (ex: 127.0.0.1:25)

Cli::save

(

)

This function saves the CLI configuration on the Axigen server

Returns:

bool

Cli::setLogHost

(

$

value

)

This function sets the address of the host that offers log services for Axigen

Returns:

bool

Parameters:

$value

int log host

Cli::setLogLevel

(

$

value

)

This function sets the log level for this service

Returns:

bool

Parameters:

$value

int log level

Cli::setLogType

(

$

value

)

This function sets the log type for this service

Returns:

bool

Parameters:

$value

int Valid values for the 'value' parameter are: "internal"(used at logging in a local file), "system"(used at logging in system log) or "remote"(used at logging on a dedicated logging machine)

Cli::setMaxAuthCommands

(

$

value

)

is function sets the maximum number of commands the CLI service performs before the user logs in

Returns:

bool

Parameters:

$value

int maximum number of authentication commands

Cli::setMaxAuthErrors

(

$

value

)

This function sets the maximum number of authentication errors after which the connection is terminated

Returns:

bool

Parameters:

$value

int maximum number of authentication errors

Cli::setMaxConnThreads

(

$

value

)

This function sets the maximum number of threads involved in I/O for this service

Returns:

bool

Parameters:

$value

int maximum number of connection threads

Cli::setMaxErrors

(

$

value

)

This function sets the maximum number of protocol errors after which the connection is terminated.

Returns:

bool

Parameters:

$value

int max errors

Cli::setMinConnThreads

(

$

value

)

This function sets the minimum number of threads involved in I/O for this service

Returns:

bool

Parameters:

$value

int minimum number of connection threads

Cli::start

(

)

This function starts the CLI service

Returns:

bool

Cli::stop

(

)

This function stops the CLI service

Returns:

bool

Cli::updateListener

(

$

address

)

This function updates a listener of this service

Returns:

object Listener

Parameters:

$address

int the listener address (ex: 127.0.0.1:25)