OWBI1::BI1PolledProviderIFC Class Reference

#include <OWBI1_PolledProviderIFC.hpp>

Inheritance diagram for OWBI1::BI1PolledProviderIFC:

Inheritance graph
[legend]
Collaboration diagram for OWBI1::BI1PolledProviderIFC:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~BI1PolledProviderIFC ()
virtual Int32 poll (const ProviderEnvironmentIFCRef &env)=0
 Called by the CIMOM to give this BI1PolledProviderIFC to opportunity to export indications if needed.
virtual Int32 getInitialPollingInterval (const ProviderEnvironmentIFCRef &env)=0
virtual void doCooperativeCancel ()
 This function is available for subclasses to override if they wish to be notified when a cooperative cancel is being invoked on the thread.
virtual void doDefinitiveCancel ()
 See the documentation for doCooperativeCancel().
virtual BI1PolledProviderIFCgetPolledProvider ()
virtual bool canUnload ()

Detailed Description

Definition at line 44 of file OWBI1_PolledProviderIFC.hpp.


Constructor & Destructor Documentation

OWBI1::BI1PolledProviderIFC::~BI1PolledProviderIFC  )  [virtual]
 

Definition at line 43 of file OWBI1_PolledProviderIFC.cpp.


Member Function Documentation

bool OWBI1::BI1PolledProviderIFC::canUnload  )  [virtual]
 

Reimplemented from OWBI1::BI1ProviderBaseIFC.

Definition at line 67 of file OWBI1_PolledProviderIFC.cpp.

void OWBI1::BI1PolledProviderIFC::doCooperativeCancel  )  [virtual]
 

This function is available for subclasses to override if they wish to be notified when a cooperative cancel is being invoked on the thread.

Note that this function will be invoked in a separate thread. For instance, a thread may use this function to write to a pipe or socket, if Thread::run() is blocked in select(), it can be unblocked and instructed to exit.

It is also possible for an individual thread to override the cancellation request, if it knows that cancellation at this time may crash the system or cause a deadlock. To do this, the thread should throw an CancellationDeniedException. Note that threads are usually only cancelled in the event of a system shutdown or restart, so a thread should make a best effort to actually shutdown.

Exceptions:
CancellationDeniedException 

Definition at line 49 of file OWBI1_PolledProviderIFC.cpp.

void OWBI1::BI1PolledProviderIFC::doDefinitiveCancel  )  [virtual]
 

See the documentation for doCooperativeCancel().

When definitiveCancel() is called on a thread, first doCooperativeCancel() will be called, and then doDefinitiveCancel() will be called.

Exceptions:
CancellationDeniedException 

Definition at line 54 of file OWBI1_PolledProviderIFC.cpp.

virtual Int32 OWBI1::BI1PolledProviderIFC::getInitialPollingInterval const ProviderEnvironmentIFCRef env  )  [pure virtual]
 

Returns:
The amount of seconds before the first call to the poll method. If this method returns zero, then the poll method is never called.

BI1PolledProviderIFC * OWBI1::BI1PolledProviderIFC::getPolledProvider  )  [virtual]
 

Reimplemented from OWBI1::BI1ProviderBaseIFC.

Definition at line 60 of file OWBI1_PolledProviderIFC.cpp.

virtual Int32 OWBI1::BI1PolledProviderIFC::poll const ProviderEnvironmentIFCRef env  )  [pure virtual]
 

Called by the CIMOM to give this BI1PolledProviderIFC to opportunity to export indications if needed.

Parameters:
lch A local CIMOM handle the provider can use to export indications if needed.
Returns:
How many seconds before the next call to the poll method. If this method returns -1 then the last polling interval will be used. If it returns 0 then the poll method will never be called again.


The documentation for this class was generated from the following files:
Generated on Thu Feb 9 09:18:53 2006 for openwbem by  doxygen 1.4.6