IInputPortNotifications Struct Reference

Notifications object passed to the input port on construction by its owner (listener). More...

Inheritance diagram for IInputPortNotifications:

Collaboration diagram for IInputPortNotifications:

Detailed Description

Notifications object passed to the input port on construction by its owner (listener).

Input ports invoke the notification functions within the Input port notifications object when corresponding events occur. The listener can then react on those events.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	acceptsSignal (IInputPort *port, ISignal *signal, Bool *accept)=0
	Called when the Input port method acceptsSignal is called. Should return true if the signal is accepted; false otherwise. More...
virtual ErrCode INTERFACE_FUNC	connected (IInputPort *port)=0
	Called when a signal is connected to the input port. More...
virtual ErrCode INTERFACE_FUNC	disconnected (IInputPort *port)=0
	Called when a signal is disconnected from the input port. More...
virtual ErrCode INTERFACE_FUNC	packetReceived (IInputPort *port)=0
	Notifies the listener of the newly received packet on the specified input-port. More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

acceptsSignal()

virtual ErrCode INTERFACE_FUNC acceptsSignal ( IInputPort *  port, ISignal *  signal, Bool *  accept  )

pure virtual

Called when the Input port method acceptsSignal is called. Should return true if the signal is accepted; false otherwise.

Parameters

	port	The input port on which the method was called.
	signal	The signal which is being checked for acceptance.
[out]	accept	True if the signal is accepted; false otherwise.

connected()

virtual ErrCode INTERFACE_FUNC connected ( IInputPort *  port )

pure virtual

Called when a signal is connected to the input port.

Parameters

port	The port to which the signal was connected.

disconnected()

virtual ErrCode INTERFACE_FUNC disconnected ( IInputPort *  port )

pure virtual

Called when a signal is disconnected from the input port.

Parameters

port	The port from which a signal was disconnected.

packetReceived()

virtual ErrCode INTERFACE_FUNC packetReceived ( IInputPort *  port )

pure virtual

Notifies the listener of the newly received packet on the specified input-port.

Parameters

port	The port on which the new packet was received.