Package onep :: Package element :: Module ApplEvent :: Class ApplEvent
[frames] | no frames]

Class ApplEvent


An event that indicates that an App event occurred in a network element.

An App event is triggered by other onep Apps using the publish_appl_event() method.

Instance Methods
 
__init__(self, element, applID, applType, applData1, applData2, applData3, applData4, eventHandle=None)
Constructor - used internally
 
do_event(self, ne)
This method specifies what action to do when an event is processed.

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

Class Variables

Inherited from core.event.AsyncMsg.AsyncMsg: OnepAsyncMsgType

Instance Variables
  applData
The list of application data buffers.
  applID
The application ID.
  applType
The application type.
int event_handle
A unique ID to identify which event listener should receive the event.

Inherited from core.event.EventObject.EventObject: event_type

Inherited from core.event.AsyncMsg.AsyncMsg: src_ne

Properties

Inherited from object: __class__

Method Details

__init__(self, element, applID, applType, applData1, applData2, applData3, applData4, eventHandle=None)
(Constructor)

 

Constructor - used internally

Parameters:
  • element - The Network Element object
  • applId - The Application ID.
  • applType - The Application type.
  • applData1 - Data buffer 1.
  • applData2 - Data buffer 2.
  • applData3 - Data buffer 3.
  • applData4 - Data buffer 4.
  • eventHandle - Event handle is a unique ID to identify which event listener should receive the event. Not needed when an event is created to be published
Overrides: object.__init__

do_event(self, ne)

 

This method specifies what action to do when an event is processed.

For AppEvent, the action is invoking the client's event listener.

Parameters:
  • ne - The source of the event. For AppEvent, the source in an instance of NetworkElement.
Overrides: core.event.AsyncMsg.AsyncMsg.do_event

Instance Variable Details

event_handle

A unique ID to identify which event listener should receive the event.
Type:
int