Struct xpcom::interfaces::nsIPresentationControlService [] [src]

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

interface nsIPresentationControlService : nsISupports

/**
 * Presentation control service which can be used for both presentation
 * control client and server.
 */

Methods

impl nsIPresentationControlService
[src]

[src]

Cast this nsIPresentationControlService to one of its base interfaces.

impl nsIPresentationControlService
[src]

[src]

/**
   * This method initializes server socket. Caller should set listener and
   * monitor onServerReady event to get the correct server info.
   * @param   aEncrypted
   *          True for using TLS control channel.
   * @param   aPort
   *          The port of the server socket.  Pass 0 or opt-out to indicate no
   *          preference, and a port will be selected automatically.
   * @throws  NS_ERROR_FAILURE if the server socket has been inited or the
   *          server socket can not be inited.
   */

void startServer (in boolean aEncrypted, [optional] in uint16_t aPort);

[src]

/**
   * Request connection to designated remote presentation control receiver.
   * @param   aDeviceInfo
   *          The remtoe device info for establish connection.
   * @returns The control channel for this session.
   * @throws  NS_ERROR_FAILURE if the Id hasn't been inited.
   */

nsIPresentationControlChannel connect (in nsITCPDeviceInfo aDeviceInfo);

[src]

/**
   * Check the compatibility to remote presentation control server.
   * @param  aVersion
   *         The version of remote server.
   */

boolean isCompatibleServer (in uint32_t aVersion);

[src]

/**
   * Close server socket and call |listener.onClose(NS_OK)|
   */

void close ();

[src]

/**
   * Get the listen port of the TCP socket, valid after the server is ready.
   * 0 indicates the server socket is not ready or is closed.
   */

readonly attribute uint16_t port;

[src]

/**
   * The protocol version implemented by this server.
   */

readonly attribute uint32_t version;

[src]

/**
   * The id of the TCP presentation server. |requestSession| won't
   * work until the |id| is set.
   */

attribute AUTF8String id;

[src]

/**
   * The id of the TCP presentation server. |requestSession| won't
   * work until the |id| is set.
   */

attribute AUTF8String id;

[src]

/**
   * The fingerprint of the TLS server certificate.
   * Empty string indicates the server is not ready or not encrypted.
   */

attribute AUTF8String certFingerprint;

[src]

/**
   * The fingerprint of the TLS server certificate.
   * Empty string indicates the server is not ready or not encrypted.
   */

attribute AUTF8String certFingerprint;

[src]

/**
   * The listener for handling events of this presentation control server.
   * Listener must be provided before invoke |startServer| and |close|.
   */

attribute nsIPresentationControlServerListener listener;

[src]

/**
   * The listener for handling events of this presentation control server.
   * Listener must be provided before invoke |startServer| and |close|.
   */

attribute nsIPresentationControlServerListener listener;

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIPresentationControlService
[src]

IID: nsIID = nsID(1440134661, 9097, 19118, [168, 254, 96, 212, 68, 5, 64, 234])

[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 nsIPresentationControlService
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIPresentationControlService
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.