Struct xpcom::interfaces::nsIMessageSender [] [src]

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

interface nsIMessageSender : nsIMessageListenerManager

/**
 * Message "senders" have a single "other side" to which messages are
 * sent.  For example, a child-process message manager will send
 * messages that are only delivered to its one parent-process message
 * manager.
 */

Methods

impl nsIMessageSender
[src]

[src]

Cast this nsIMessageSender to one of its base interfaces.

impl nsIMessageSender
[src]

[src]

/**
  * For remote browsers there is always a corresponding process message
  * manager. The intention of this attribute is to link leaf level frame
  * message managers on the parent side with the corresponding process
  * message managers (if there is one). For any other cases this property
  * is null.
  */

readonly attribute nsIMessageSender processMessageManager;

[src]

/**
  * For remote browsers, this contains the remoteType of the content child.
  * Otherwise, it is empty.
  */

readonly attribute AString remoteType;

Methods from Deref<Target = nsIMessageListenerManager>

[src]

Cast this nsIMessageListenerManager to one of its base interfaces.

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

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

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

[src]

[notxpcom] boolean markForCC ();

Trait Implementations

impl XpCom for nsIMessageSender
[src]

IID: nsIID = nsID(3143465444, 59196, 17895, [150, 81, 77, 113, 143, 75, 153, 76])

[src]

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. Read more

impl RefCounted for nsIMessageSender
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIMessageSender
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.