ClearOS API

Description

Bandwidth manager

author: Point Clark Networks
copyright: Copyright 2003-2009, Point Clark Networks
license: GNU Public License

Located in /api/Bandwidth.class.php (line 60)

Engine
   |
   --Software
      |
      --Daemon
         |
         --Firewall
            |
            --Bandwidth

Class Constant Summary

CONSTANT_SPEED_NOT_SET = 0

DIR_DESTINED_GW = 3

DIR_DESTINED_LAN = 1

DIR_ORIGINATING_GW = 2

DIR_ORIGINATING_LAN = 0

FILE_CONFIG = '/etc/firewall'

MAX_IP_RANGE = 255

MODE_LIMIT = 0

MODE_RESERVE = 1

TYPE_BASIC = 1

Variable Summary

mixed $config

mixed $is_loaded

Method Summary

Bandwidth __construct ()

void AddBandwidthRule (string $name, string $ifn, string $src_addr, string $src_port, string $ip, int $port, int $priority, int $upstream, int $upstream_ceil, int $downstream, int $downstream_ceil)

void AddBasicBandwidthRule (string $name, int $mode, array $service, int $dir, int $speed, int $priority)

void DeleteBandwidthRule (string $ifn, string $src_addr, string $src_port, string $ip, string $port, int $priority, int $upstream, int $upstream_ceil, int $downstream, int $downstream_ceil)

void DeleteBasicBandwidthRule (string $name)

void Disable ()

void Enable ()

array GetBandwidthRules ()

array GetInterfaces ()

boolean GetState ()

boolean IsInitialized ()

void IsValidSpeed ( $speed)

void ToggleEnableBandwidthRule (boolean $enabled, string $ifn, string $src_addr, string $src_port, string $ip, string $port, int $priority, int $upstream, int $upstream_ceil, int $downstream, int $downstream_ceil)

void ToggleEnableBasicBandwidthRule (boolean $enabled, string $name)

void UpdateInterface ( $interface, int $upstream, int $downstream, string $iface)

void _LoadConfiguration ()

void _SaveConfiguration ()

Variables

mixed $config = array() (line 81)

access: protected

mixed $is_loaded = false (line 80)

access: protected

Inherited Variables

Inherited from Daemon

Daemon::$initscript
Daemon::$package
Daemon::$processname
Daemon::$reloadable
Daemon::$title

Inherited from Software

Software::$copyright
Software::$description
Software::$installsize
Software::$installtime
Software::$packager
Software::$pkgname
Software::$release
Software::$summary
Software::$version

Inherited from Engine

Engine::$errors

Methods

Constructor __construct (line 91)

Bandwidth constructor.

Bandwidth __construct ()

Redefinition of:

Firewall::__construct(): Firewall constructor.

AddBandwidthRule (line 221)

Add a new Bandwidth Rule.

throws: ValidationException, EngineException
access: public

void AddBandwidthRule (string $name, string $ifn, string $src_addr, string $src_port, string $ip, int $port, int $priority, int $upstream, int $upstream_ceil, int $downstream, int $downstream_ceil)

string $name: the bandwidth rule name
string $ifn: the external interface
string $src_addr: addr type: 0 destination, 1 source
string $src_port: src type: 0 destination, 1 source
string $ip: the IP address
int $port: the port
int $priority: priority
int $upstream: upstream rate
int $upstream_ceil: upstream ceiling
int $downstream: downstream rate
int $downstream_ceil: downstream ceiling

AddBasicBandwidthRule (line 113)

Add a new 'basic' Bandwidth Rule.

throws: ValidationException, EngineException
access: public

void AddBasicBandwidthRule (string $name, int $mode, array $service, int $dir, int $speed, int $priority)

string $name: the bandwidth rule name
int $mode: rule mode, limit or reserve
array $service
int $dir: rule direction
int $speed: upstream/downstream rate
int $priority: rule priority

DeleteBandwidthRule (line 399)

Delete an existing bandwidth rule.

throws: EngineException
access: public

void DeleteBandwidthRule (string $ifn, string $src_addr, string $src_port, string $ip, string $port, int $priority, int $upstream, int $upstream_ceil, int $downstream, int $downstream_ceil)

string $ifn: external interface
string $src_addr: addr type: 0 destination, 1 source
string $src_port: port type: 0 destination, 1 source
string $ip: the IP address
string $port: the port
int $priority: priority
int $upstream: upstream rate
int $upstream_ceil: upstream ceiling
int $downstream: downstream rate
int $downstream_ceil: downstream rate

DeleteBasicBandwidthRule (line 362)

Delete an existing "basic" bandwidth rule.

throws: EngineException
access: public

void DeleteBasicBandwidthRule (string $name)

string $name: basic bandwidth rule ID

Disable (line 431)

Disables bandwidth manager.

throws: EngineException
access: public

void Disable ()

Enable (line 458)

Enables bandwidth manager.

throws: EngineException
access: public

void Enable ()

GetBandwidthRules (line 485)

Get all bandwidth rules.

return: a list of all bandwidth rules
throws: EngineException
access: public

array GetBandwidthRules ()

GetInterfaces (line 557)

Returns network interface details.

return: information about network interfaces
throws: EngineException
access: public

array GetInterfaces ()

GetState (line 604)

Returns the state of the bandwidth manager.

return: true if bandwidth manager is enabled
throws: EngineException
access: public

boolean GetState ()

Redefinition of:

Firewall::GetState(): Generic get state for a on/off key.

IsInitialized (line 624)

Returns state of network interface configuration details.

return: true if all network interfaces have been configured.
throws: EngineException
access: public

boolean IsInitialized ()

IsValidSpeed (line 703)

access: public

void IsValidSpeed ( $speed)

$speed

ToggleEnableBandwidthRule (line 323)

Toggle the enabled status of an existing bandwidth rule.

throws: EngineException
access: public

void ToggleEnableBandwidthRule (boolean $enabled, string $ifn, string $src_addr, string $src_port, string $ip, string $port, int $priority, int $upstream, int $upstream_ceil, int $downstream, int $downstream_ceil)

boolean $enabled: the status
string $ifn: external interface
string $src_addr: addr type: 0 destination, 1 source
string $src_port: port type: 0 destination, 1 source
string $ip: the IP address
string $port: the port
int $priority: priority
int $upstream: upstream rate
int $upstream_ceil: upstream ceiling
int $downstream: downstream rate
int $downstream_ceil: downstream rate

ToggleEnableBasicBandwidthRule (line 283)

Toggle the enabled status of an existing "basic" bandwidth rule.

throws: EngineException
access: public

void ToggleEnableBasicBandwidthRule (boolean $enabled, string $name)

boolean $enabled: the status
string $name: bandwidth rule ID

UpdateInterface (line 649)

Updates network interface information for a given interface.

throws: EngineException
access: public

void UpdateInterface ( $interface, int $upstream, int $downstream, string $iface)

string $iface: network interface
int $upstream: upstream speed in kbit/s
int $downstream: downstream speed in kbit/s
$interface

_LoadConfiguration (line 725)

Loads bandwidth configuration.

throws: ValidationException, EngineException
access: public

void _LoadConfiguration ()

_SaveConfiguration (line 777)

Saves bandwidth configuration.

throws: ValidationException, EngineException
access: public

void _SaveConfiguration ()

Inherited Methods

Inherited From Firewall

Firewall::__construct()
Firewall::AddHost()
Firewall::AddMac()
Firewall::AddPort()
Firewall::AddPortRange()
Firewall::AddRule()
Firewall::AddStandardService()
Firewall::DeleteHost()
Firewall::DeleteMac()
Firewall::DeletePort()
Firewall::DeletePortRange()
Firewall::DeleteRule()
Firewall::FindRule()
Firewall::GetHosts()
Firewall::GetInterfaceDefinition()
Firewall::GetInterfaceRole()
Firewall::GetInterfaceRoleText()
Firewall::GetMacs()
Firewall::GetMode()
Firewall::GetPortRanges()
Firewall::GetPorts()
Firewall::GetRules()
Firewall::GetStandardServiceList()
Firewall::GetState()
Firewall::GetValue()
Firewall::IsValidIp()
Firewall::IsValidMac()
Firewall::IsValidMode()
Firewall::IsValidPort()
Firewall::IsValidPortRange()
Firewall::IsValidProtocol()
Firewall::IsValidServer()
Firewall::IsValidService()
Firewall::LookupHostMetainfo()
Firewall::LookupService()
Firewall::RemoveInterfaceRole()
Firewall::SetInterface()
Firewall::SetInterfaceRole()
Firewall::SetMode()
Firewall::SetRules()
Firewall::SetState()
Firewall::SetValue()

Inherited From Daemon

Daemon::__construct()
Daemon::GetBootState()
Daemon::GetProcessName()
Daemon::GetRunningState()
Daemon::GetTitle()
Daemon::Reset()
Daemon::Restart()
Daemon::SetBootState()
Daemon::SetRunningState()
Daemon::__destruct()

Inherited From Software

Software::__construct()
Software::GetCopyright()
Software::GetDescription()
Software::GetInstallSize()
Software::GetInstallTime()
Software::GetPackageName()
Software::GetPackager()
Software::GetRelease()
Software::GetRpmInfo()
Software::GetSummary()
Software::GetVersion()
Software::IsInstalled()
Software::__destruct()

Inherited From Engine

Engine::__construct()
Engine::AddValidationError()
Engine::CheckValidationErrors()
Engine::CopyValidationErrors()
Engine::GetValidationErrors()
Engine::Log()
Engine::__destruct()

Class Constants

CONSTANT_SPEED_NOT_SET = 0 (line 68)

DIR_DESTINED_GW = 3 (line 76)

DIR_DESTINED_LAN = 1 (line 74)

DIR_ORIGINATING_GW = 2 (line 75)

DIR_ORIGINATING_LAN = 0 (line 73)

FILE_CONFIG = '/etc/firewall' (line 66)

MAX_IP_RANGE = 255 (line 67)

MODE_LIMIT = 0 (line 70)

MODE_RESERVE = 1 (line 71)

TYPE_BASIC = 1 (line 78)

Inherited Constants

Inherited from Firewall

Firewall::CONSTANT_ALL_PORTS
Firewall::CONSTANT_ALL_PROTOCOLS
Firewall::CONSTANT_AUTO
Firewall::CONSTANT_DISABLED
Firewall::CONSTANT_DMZ
Firewall::CONSTANT_ENABLED
Firewall::CONSTANT_EXTERNAL
Firewall::CONSTANT_GATEWAY
Firewall::CONSTANT_HOT_LAN
Firewall::CONSTANT_LAN
Firewall::CONSTANT_MULTIPATH
Firewall::CONSTANT_NORMAL
Firewall::CONSTANT_NOT_CONFIGURED
Firewall::CONSTANT_OFF
Firewall::CONSTANT_ON
Firewall::CONSTANT_ONE_TO_ONE_NAT_START
Firewall::CONSTANT_PORT_RANGE
Firewall::CONSTANT_PROTOCOL_TCP
Firewall::CONSTANT_PROTOCOL_UDP
Firewall::CONSTANT_SPECIAL
Firewall::CONSTANT_STANDALONE
Firewall::CONSTANT_TRUSTEDGATEWAY
Firewall::CONSTANT_TRUSTEDSTANDALONE
Firewall::FILE_CONFIG
Firewall::FILE_CUSTOM_RULES

Inherited from Daemon

Daemon::CMD_CHKCONFIG
Daemon::CMD_LS
Daemon::CMD_PIDOF
Daemon::CMD_SERVICE
Daemon::PATH_INITD

Inherited from Software

Software::COMMAND_RPM

Inherited from Engine

Engine::COMMAND_API

ClearFoundation

Class Bandwidth

Inherited Variables

Inherited Methods

Inherited Constants

Foundation

Software

Community

Contribute