All Classes Functions Variables Typedefs Friends Pages
Public Member Functions | List of all members
Glympse::IApiStatus Struct Referenceabstract

Provides the ability to query the availability of the Glympse API services. More...

#include <IApiStatus.h>

Inheritance diagram for Glympse::IApiStatus:
Inheritance graph
[legend]

Public Member Functions

virtual bool checkStatus (const GApiStatusListener &listener)=0
 Check the status of the Glympse API services. More...
 
- Public Member Functions inherited from Glympse::ICommon
virtual int32 retain ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 release ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hold ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 unhold ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hashCode ()=0
 Returns an integer hash code for this object.
 
virtual bool equals (const GCommonObj &o)=0
 Compares this instance with the specified object and indicates if they are equal. More...
 
virtual GString toString ()=0
 Returns a string containing a concise, human-readable description of this object. More...
 
virtual void attachObject (const GCommon &obj)=0
 Asociates arbitrary object with the instance.
 
virtual GCommon extractObject ()=0
 Extracts associated object or NULL if no association is established.
 

Additional Inherited Members

- Protected Member Functions inherited from Glympse::ICommon
virtual ~ICommon ()
 Destructor is protected to deny explicit object deallocation. More...
 

Detailed Description

Provides the ability to query the availability of the Glympse API services.

Member Function Documentation

virtual bool Glympse::IApiStatus::checkStatus ( const GApiStatusListener listener)
pure virtual

Check the status of the Glympse API services.

This is a one-shot API status check and only a single status request may be active at any given time. Upon API status determination, the provided listener will be notified via the statusUpdated(...) method.

Note that each time this method is successfully invoked, a thread is spawned and one or more network operations are performed in order to determine the Glympse API service status.

Parameters
listenerThe listener to be updated when the API status is determined.
Returns
true, if the status request was successfully queued, false otherwise.

The documentation for this struct was generated from the following file: