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

Provides access to handoff provider and sends corresponding events. More...

#include <IHandoffManager.h>

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

Public Member Functions

virtual GHandoffProvider getHandoffProvider ()=0
 Provides access to currently active handoff provider. More...
 
virtual bool forceHandoffProvider (const GString &providerId, const GPrimitive &data)=0
 Attempts to set the matching handoff provider as the currently active handoff provider. More...
 
virtual bool disableHandoffProvider ()=0
 Disables the currently active handoff provider, if it is a forceable provider.
 
Debug Tools

All methods from this section are intended for development purposes only and are not supposed to be invoked from production code.

virtual void overrideProviderConfig (const GString &providerId, const GPrimitive &config)=0
 Overrides default configuration of a handoff provider. More...
 
- Public Member Functions inherited from Glympse::IEventSink
virtual bool addListener (const GEventListener &eventListener)=0
 Registeres event listener on the sink. More...
 
virtual bool removeListener (const GEventListener &eventListener)=0
 Unsubscribes listener from events coming from this sink.
 
virtual GArray< GEventListener >
::ptr 
getListeners ()=0
 Provides access to the collection of current listeners. More...
 
virtual bool hasContext (int64 key)=0
 Checks, where user context identified by key is already associated with the object.
 
virtual void associateContext (int64 key, const GCommonObj &value)=0
 Associates specific context (user data) with the sink. More...
 
virtual GCommonObj getContext (int64 key)=0
 Returns context associated with the sink, or NULL, if it is not found.
 
virtual void clearContext (int64 key)=0
 Clears context identified by key argument.
 
virtual GEnumeration< GLong >::ptr getContextKeys ()=0
 Gets enumeration of all context keys associated with the sink.
 
virtual void deriveContext (const GEventSink &sink)=0
 Derives context from another sink object.
 
- Public Member Functions inherited from Glympse::IEventListener
virtual void eventsOccurred (const GGlympse &glympse, int32 listener, int32 events, const GCommonObj &obj)=0
 This method is invoked each time, when sink object notifies subscriber on an event. 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 access to handoff provider and sends corresponding events.

See Also
GE::LISTENER_HANDOFF
IHandoffProvider

Member Function Documentation

virtual bool Glympse::IHandoffManager::forceHandoffProvider ( const GString providerId,
const GPrimitive data 
)
pure virtual

Attempts to set the matching handoff provider as the currently active handoff provider.

All current and future tickets will be handed off to this provider. Provider must be "forceable" and a non-forceable provider must not be currently active.

Parameters
providerIdHandoff provider ID.
configPrimitive object containing the properties specific to the handoff provider.
virtual GHandoffProvider Glympse::IHandoffManager::getHandoffProvider ( )
pure virtual

Provides access to currently active handoff provider.

Returns
Instance of handoff provider or NULL.
virtual void Glympse::IHandoffManager::overrideProviderConfig ( const GString providerId,
const GPrimitive config 
)
pure virtual

Overrides default configuration of a handoff provider.

This method should be called before platform is started othwrise it makes no affect.

Parameters
providerIdHandoff provider ID.
configPrimitive object containing the properties to be overridden.

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