Interface nsISocketProviderType

nsISocketProvider

Hierarchy

Methods

AddRef QueryInterface Release addToSocket newSocket

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

addToSocket

  • addToSocket

    This function is called to allow the socket provider to layer a PRFileDesc on top of another PRFileDesc. For example, SSL via a SOCKS proxy.

    Parameters are the same as newSocket with the exception of aFileDesc, which is an in-param instead.

    Parameters

    • aFamily: number
    • aHost: string
    • aPort: number
    • aProxy: nsIProxyInfo
    • aOriginAttributes: const_OriginAttributesRef
    • aFlags: number
    • aTlsFlags: number
    • aFileDesc: PRFileDescStar
    • aTLSSocketControl: nsITLSSocketControl

    Returns void

newSocket

  • newSocket

    Parameters

    • aFamily: number

      The address family for this socket (PR_AF_INET or PR_AF_INET6).

    • aHost: string

      The origin hostname for this connection.

    • aPort: number

      The origin port for this connection.

    • aProxy: nsIProxyInfo
    • aOriginAttributes: const_OriginAttributesRef
    • aFlags: number

      Control flags that govern this connection (see below.)

    • aTlsFlags: number

      An opaque flags for non-standard behavior of the TLS system. It is unlikely this will need to be set outside of telemetry studies relating to the TLS implementation.

    • aFileDesc: PRFileDescStar

      The resulting PRFileDesc.

    • aTLSSocketControl: nsITLSSocketControl

      TLS socket control object that should be associated with aFileDesc, if applicable.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc