Struct xpcom::interfaces::nsIMessageBroadcaster

#[repr(C)]
pub struct nsIMessageBroadcaster { /* fields omitted */ }

interface nsIMessageBroadcaster : nsIMessageListenerManager

/**
 * Message "broadcasters" don't have a single "other side" that they
 * send messages to, but rather a set of subordinate message managers.
 * For example, broadcasting a message through a window message
 * manager will broadcast the message to all frame message managers
 * within its window.
 */

Methods

impl nsIMessageBroadcaster

pub fn coerce<T: nsIMessageBroadcasterCoerce>(&self) -> &T

Cast this nsIMessageBroadcaster to one of its base interfaces.

impl nsIMessageBroadcaster

pub unsafe fn GetChildCount(&self, aChildCount: *mut uint32_t) -> nsresult

/**
   * Number of subordinate message managers.
   */

readonly attribute unsigned long childCount;

pub unsafe fn GetChildAt(
    &self,
    aIndex: uint32_t,
    _retval: *mut *const nsIMessageListenerManager
) -> nsresult

/**
   * Return a single subordinate message manager.
   */

nsIMessageListenerManager getChildAt (in unsigned long aIndex);

pub unsafe fn ReleaseCachedProcesses(&self) -> nsresult

/**
   * Some processes are kept alive after their last tab/window are closed for testing
   * (see dom.ipc.keepProcessesAlive). This function releases those.
   */

void releaseCachedProcesses ();

Methods from Deref<Target = nsIMessageListenerManager>

pub fn coerce<T: nsIMessageListenerManagerCoerce>(&self) -> &T

Cast this nsIMessageListenerManager to one of its base interfaces.

pub unsafe fn AddMessageListener(
    &self,
    messageName: &nsAString,
    listener: *const nsIMessageListener,
    listenWhenClosed: bool
) -> nsresult

/**
   * Register |listener| to receive |messageName|.  All listener
   * callbacks for a particular message are invoked when that message
   * is received.
   *
   * The message manager holds a strong ref to |listener|.
   *
   * If the same listener registers twice for the same message, the
   * second registration is ignored.
   *
   * Pass true for listenWhenClosed if you want to receive messages
   * during the short period after a frame has been removed from the
   * DOM and before its frame script has finished unloading. This
   * parameter only has an effect for frame message managers in
   * the main process. Default is false.
   */

void addMessageListener (in AString messageName, in nsIMessageListener listener, [optional] in boolean listenWhenClosed);

pub unsafe fn RemoveMessageListener(
    &self,
    messageName: &nsAString,
    listener: *const nsIMessageListener
) -> nsresult

/**
   * Undo an |addMessageListener| call -- that is, calling this causes us to no
   * longer invoke |listener| when |messageName| is received.
   *
   * removeMessageListener does not remove a message listener added via
   * addWeakMessageListener; use removeWeakMessageListener for that.
   */

void removeMessageListener (in AString messageName, in nsIMessageListener listener);

pub unsafe fn AddWeakMessageListener(
    &self,
    messageName: &nsAString,
    listener: *const nsIMessageListener
) -> nsresult

/**
   * This is just like addMessageListener, except the message manager holds a
   * weak ref to |listener|.
   *
   * If you have two weak message listeners for the same message, they may be
   * called in any order.
   */

void addWeakMessageListener (in AString messageName, in nsIMessageListener listener);

pub unsafe fn RemoveWeakMessageListener(
    &self,
    messageName: &nsAString,
    listener: *const nsIMessageListener
) -> nsresult

/**
   * This undoes an |addWeakMessageListener| call.
   */

void removeWeakMessageListener (in AString messageName, in nsIMessageListener listener);

pub unsafe fn MarkForCC(&self) -> bool

[notxpcom] boolean markForCC ();

Trait Implementations

impl XpCom for nsIMessageBroadcaster

const IID: nsIID

IID: nsIID = nsID(1300062893, 18213, 20281, [134, 207, 143, 178, 43, 249, 193, 216])

fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise.

impl RefCounted for nsIMessageBroadcaster

unsafe fn addref(&self)

Increment the reference count.

unsafe fn release(&self)

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIMessageBroadcaster

type Target = nsIMessageListenerManager

The resulting type after dereferencing.

fn deref(&self) -> &nsIMessageListenerManager

Dereferences the value.