All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIPublisher
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIPublisher
Usage: you can freely reimplement this interface.
interface ENOVIPublisher
Publishing events inside an object.
Method Index
- o
GetListOfRaisableEvents(CATListOfCATUnicodeString&)
- Return the list of events which can be raised by the Publisher.
- o
GetName(CATUnicodeString&)
- Returns the Publisher Type.
- o
GetObjectInfo(ENOVIObjectInfo_var&)
- Return a pointer to the ENOVIObjectInfo interface associated to this publisher instance.
- o
GetSubscribers(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&,ENOVIEvent::VPMEventFireMode&)
- Return the list of clients that subscribed to the specified event on this publisher instance.
- o
Subscribe(CATUnicodeString&,CATBaseUnknown_var&,IID&,ENOVIEvent::VPMEventFireMode&,unsigned long*,int&)
- Subscribe directly a client to an Event on a publisher instance.
- o
Subscribe(CATUnicodeString&,ENOVISubscriberEvent_var&,ENOVIEvent::VPMEventFireMode&,unsigned long*,int&)
- Subscribe directly a client to an Event on a publisher instance.
- o
Unsubscribe(unsigned long)
- unsubscription of the client.
Methods
o GetListOfRaisableEvents
-
Return the list of events which can be raised by the Publisher.
- Parameters:
-
- oListOfManagedEvents
- the list of events.
o GetName
-
Returns the Publisher Type.
- Parameters:
-
- oName
- Type of publisher
o GetObjectInfo
public virtual HRESULT GetObjectInfo( | ENOVIObjectInfo_var& | oObjectInfo) = 0 |
-
Return a pointer to the ENOVIObjectInfo interface associated to this publisher instance.
- Parameters:
-
- oObjectInfo
- the pointer to the ENOVIObjectInfo interface.
o GetSubscribers
-
Return the list of clients that subscribed to the specified event on this publisher instance.
- Parameters:
-
- iEventName
- name of the event subscribed to.
- oListOfSubscribers
- the returned list of subscribers as a collection of CATBaseUnknown pointers.
- iFireMode
- the step subscribed to (before/after or both i.e. standard).
o Subscribe
public virtual HRESULT Subscribe( | const CATUnicodeString& | iEventName, |
| const CATBaseUnknown_var& | iCallBackInterface, |
| const IID& | iIDOfInterface, |
| const ENOVIEvent::VPMEventFireMode& | iFireMode, |
| unsigned long* | oSubscriberCookie, |
| const int& | iPriority | = 5)=0 |
-
Subscribe directly a client to an Event on a publisher instance.
Role: allows a client to subscribe directly on a publisher, without using
ENOVIEventManager interface. It is a EARLY subscription, i.e. the client implements an explicit CallBack interface.
- Parameters:
-
- iEventName
- event name you want to subscribe to.
- iCallBackInterface
- interface for the callback methods, implemented by the client which subscribes.
- iIDOfInterface
- Real ID of iCallBackInterface
- iFireMode
- step you want to subscribe to (before/after or both).
- iPriority
- priority of subscription. from 1 to 9 - standard = 5.
- oSubscriberCookie
- a cookie to keep for a further unsubscription.
o Subscribe
public virtual HRESULT Subscribe( | const CATUnicodeString& | iEventName, |
| const ENOVISubscriberEvent_var& | iSubscriber, |
| const ENOVIEvent::VPMEventFireMode& | iFireMode, |
| unsigned long* | oSubscriberCookie, |
| const int& | iPriority | = 5)=0 |
-
Subscribe directly a client to an Event on a publisher instance.
Role: allows a client to subscribe directly on a publisher, without using
ENOVIEventManager interface. It is a LATE subscription, i.e. the client implements a generic CallBack interface
ENOVISubscriberEvent .
- Parameters:
-
- iEventName
- event name you want to subscribe to.
- iSubscriber
- implementation of callback interface ENOVISubscriberEvent
- iIDOfInterface
- Real ID of iCallBackInterface
- iFireMode
- step you want to subscribe to (before/after or both i.e. standard).
- iPriority
- priority of subscription. from 1 to 9 - standard = 5.
- oSubscriberCookie
- a cookie to keep for a further unsubscription.
o Unsubscribe
public virtual HRESULT Unsubscribe( | unsigned long | iSubscriberCookie)=0 |
-
unsubscription of the client.
- Parameters:
-
- iSubscriberCookie
- the cookie given at subscription time.
This object is included in the file: ENOVIPublisher.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces