OMV\System\Net\NetworkInterfaceBackend\BackendAbstract Class Reference

Inheritance diagram for OMV\System\Net\NetworkInterfaceBackend\BackendAbstract:

Public Member Functions
	getType ()
	enumerate ()
	enumerateSlaves ()
	isTypeOf ($deviceName)
	getImpl ($args)

Protected Member Functions
	enumerateSysFs ($regex)
	isTypeOfByName ($deviceName, $regex)

Detailed Description

The generic class that represents a network interface backend.

Member Function Documentation

OMV\System\Net\NetworkInterfaceBackend\BackendAbstract::enumerate ( )

abstract

Get a list of devices of the given network interface backend.

Returns

A list of devicefile names, otherwise FALSE.

OMV\System\Net\NetworkInterfaceBackend\BackendAbstract::enumerateSlaves

(

)

Get a list of all devices that are used by devices of this network interface backend.

Returns

A list of devicefile names, otherwise FALSE.

OMV\System\Net\NetworkInterfaceBackend\BackendAbstract::enumerateSysFs (   $regex )

finalprotected

Helper function to enumerate the network interfaces represented by this backend via the /sys filesystem.

Parameters

regex

The regular expression used to identify the devices represented by this backend.

Returns

A list of network interface names, otherwise FALSE.

OMV\System\Net\NetworkInterfaceBackend\BackendAbstract::getImpl

(

$args

)

Get the object of the class implementing the given network interface.

Parameters

args	The arguments to the class constructor.

Returns

The object of the class implementing the given network interface type, otherwise NULL.

OMV\System\Net\NetworkInterfaceBackend\BackendAbstract::getType ( )

abstract

Get the type of the network interface backend, e.g. OMV_NETWORK_INTERFACE_TYPE_ETHERNET, OMV_NETWORK_INTERFACE_TYPE_BOND, OMV_NETWORK_INTERFACE_TYPE_VLAN, ...

OMV\System\Net\NetworkInterfaceBackend\BackendAbstract::isTypeOf

(

$deviceName

)

Check whether the given device is represented by this network interface backend.

Parameters

deviceName

Specifies the device name, e.g. eth1 bond0 eth0.1 venet2

Returns

TRUE if successful, otherwise FALSE.

OMV\System\Net\NetworkInterfaceBackend\BackendAbstract::isTypeOfByName (   $deviceName,   $regex  )

finalprotected

Helper function to check whether the given device is represented by this backend.

Parameters

deviceName	Specifies the network interface name.
regex	The regular expression used to identify the devices represented by this storage backend.

---

The documentation for this class was generated from the following file:

• net/networkinterfacebackend/backendabstract.inc