• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

ToiNetService

Class Summary

Extends:
  • ToiEventTarget

ToiNetService is used to configure and retrieving information about logical networks. A logical network (aka network) is a collection of everything in the system required to allow network access. This includes network interfaces, DNS, routing and Wi-Fi management.

Service:

This is a service and can be accessed through toi.netService
  • Methods
  • Members

Method Summary

getNetwork ( networkName )  → ToiNetwork

Returns the network with the specified name.

getNetworkInterfaces ( )  → Array.<ToiNetwork.ToiInterfaceInfo>

Returns information about the available network interfaces.

Inherited Methods

addEventListener ( type , listener )

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.

removeEventListener ( type , listener )

This method removes an event listener for a specific event.

Methods

addEventListener ( type , listener )

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.

Inherited From:

  • ToiEventTarget#addEventListener

Parameters:

Name Type Description
type number

The event type of the event to subscribe to.

listener ToiEventListener

The JavaScript function that will receive events.

Throws:

ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the application calls addEventListener with the same combination of type and listener twice.

getNetwork ( networkName )  → ToiNetwork

Returns the network with the specified name.

Parameters:

Name Type Description
networkName string

The name of the network. The following named networks are currently supported: ToiNetService.BOOT_NETWORK

Throws:

ToiInvalidArgumentException

Raised if there is no network with the specified name.

Returns:

The ToiNetwork address.

Type: ToiNetwork
getNetworkInterfaces ( )  → Array.<ToiNetwork.ToiInterfaceInfo>

Returns information about the available network interfaces.

Returns:

Information about the available network interfaces.

Type: Array.<ToiNetwork.ToiInterfaceInfo>
removeEventListener ( type , listener )

This method removes an event listener for a specific event.

Inherited From:

  • ToiEventTarget#removeEventListener

Parameters:

Name Type Description
type number

The event type of the event to remove the listener from.

listener ToiEventListener

The JavaScript function that was previously added as an event listener.

Throws:

ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the listener has not previously been added.

Members

BOOT_NETWORK (Type: string) (value = '_boot_network_') (static, constant)

This string constant identifies the boot network.

This constant can be also be accessed from toi.consts.ToiNetService.BOOT_NETWORK.

5.1.p5

Copyright (c) 2017 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.