Package onep :: Package discovery :: Module DiscoveryFilter :: Class DiscoveryFilter
[frames] | no frames]

Class DiscoveryFilter


The DiscoveryFilter class represents the specifications needed to register for a service set discovery event from the root network element and/or its neighbors.

The application has to be connected to the root network element to receive service state change notifications from the root network element and its neighbors. The application can use the default constructor to define the service discovery filter or can refine the filter by selectively setting fields of interest in the service discovery filter object. When the default service set discovery filter is used, the application receives all service set change notifications for all the service sets on root network element and its directly connected neighbors. The service set discovery filter can also be defined for the filter events based on additional criteria such as the network element IP address, service set name, version, and service set state.

The DiscoveryFilter is passed into the add_discovery_listener method. A single DiscoveryFilter object can be used in multiple calls

See DiscoveryListener

Instance Methods
 
__init__(self)
The default ServiceDiscoveryFilter constructor without specifying any filter criteria.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
  DiscoveryType = enum('ONEP_DISCOVERY_ALL', 'ONEP_DISCOVERY_LOC...
Service set type that needs to be filtered.
  ServiceSetState = enum('ONEP_SERVICE_SET_STATE_ALL', 'ONEP_SER...
Service set state, either enabled or disabled
  state = property(_get_state, _set_state, None, _doc)
  name = property(_get_name, _set_name, None, _doc)
  type = property(_get_type, _set_type, None, _doc)
Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

 

The default ServiceDiscoveryFilter constructor without specifying any filter criteria.

Default constructor does not set any filter on the service discovery notifications, and the application will receive all service change notifications from the root NE and its neighbors

Overrides: object.__init__

Class Variable Details

DiscoveryType

Service set type that needs to be filtered. The application can select individual service set types or use ONEP_SERVICE_SET_ALL to set the filter for all the available service sets.

'ONEP_DISCOVERY_ALL' - Local and neighbor service set discovery 'ONEP_DISCOVERY_LOCAL' - Discover service sets on root network element 'ONEP_DISCOVERY_NEIGHBOR' - Service set discovery for directly connected neighbors of root network element

Value:
enum('ONEP_DISCOVERY_ALL', 'ONEP_DISCOVERY_LOCAL', 'ONEP_DISCOVERY_NEI\
GHBOR')

ServiceSetState

Service set state, either enabled or disabled

Value:
enum('ONEP_SERVICE_SET_STATE_ALL', 'ONEP_SERVICE_SET_ENABLED', 'ONEP_S\
ERVICE_SET_DISABLED')