Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIEventQueueService Interface Reference

import "nsIEventQueueService.idl";

Inheritance diagram for nsIEventQueueService:
Inheritance graph
[legend]
Collaboration diagram for nsIEventQueueService:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void createThreadEventQueue ()
 Creates and holds a native event queue for the current thread.
void createMonitoredThreadEventQueue ()
 Creates and hold a monitored event queue for the current thread.
void destroyThreadEventQueue ()
 Somewhat misnamed, this method releases the service's hold on the event queue(s) for this thread.
nsIEventQueue createFromIThread (in nsIThread aThread, in boolean aNative)
nsIEventQueue createFromPLEventQueue (in PLEventQueuePtr aPLEventQueue)
nsIEventQueue pushThreadEventQueue ()
void popThreadEventQueue (in nsIEventQueue aQueue)
nsIEventQueue getThreadEventQueue (in PRThreadPtr aThread)
nsIEventQueue resolveEventQueue (in nsIEventQueue queueOrConstant)
nsIEventQueue getSpecialEventQueue (in long aQueue)
 Returns the appropriate special event queue, AddRef()ed.

Public Attributes

const long CURRENT_THREAD_EVENT_QUEUE = 0
const long UI_THREAD_EVENT_QUEUE = 1

Detailed Description

Definition at line 74 of file nsIEventQueueService.idl.


Member Function Documentation

Creates and hold a monitored event queue for the current thread.

"Monitored" queues have no callback processing mechanism.

Returns:
NS_OK on success, or a host of failure indications

Creates and holds a native event queue for the current thread.

"Native" queues have an associated callback mechanism which is automatically triggered when an event is posted. See plevent.c for details.

Returns:
NS_OK on success, or a host of failure indications

Somewhat misnamed, this method releases the service's hold on the event queue(s) for this thread.

Subsequent attempts to access this thread's queue (GetThreadEventQueue, for example) may fail, though the queue itself will be destroyed only after all references to it are released and the queue itself is no longer actively processing events.

Returns:
nonsense.

Returns the appropriate special event queue, AddRef()ed.

Really just a scriptable version of ResolveEventQueue.

  • aQueue Either CURRENT_THREAD_EVENT_QUEUE or UI_THREAD_EVENT_QUEUE
    Returns:
    The requested nsIEventQueue, AddRef()ed
    Exceptions:
    NS_ERROR_NULL_POINTERZero pointer passed in for return value
    NS_ERROR_ILLEGAL_VALUEBogus constant passed in aQueue
    NS_ERROR_FAILUREError while calling GetThreadEventQueue()
Deprecated:
in favor of getSpecialEventQueue, since that's scriptable and this isn't.

Check for any "magic" event queue constants (NS_CURRENT_EVENTQ, NS_UI_THREAD_EVENTQ) and return the real event queue that they represent, AddRef()ed. Otherwise, return the event queue passed in, AddRef()ed. This is not scriptable because the arguments in question may be magic constants rather than real nsIEventQueues.

  • queueOrConstant either a real event queue or a magic constant to be resolved
Returns:
a real event queue, AddRef()ed

Member Data Documentation

Definition at line 148 of file nsIEventQueueService.idl.

Definition at line 149 of file nsIEventQueueService.idl.


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