WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsISocketProvider

IID:00b3df92-e830-11d8-d48e-0004e22243f8
Inherits From:nsISupports

This interface is implemented by the following components:


Constants

PROXY_RESOLVES_HOST

This flag is set if the proxy is to perform hostname resolution instead of the client. When set, the hostname parameter passed when in this interface will be used instead of the address structure passed for a later connect et al. request.

PRInt32 PROXY_RESOLVES_HOST = 1

Methods

[noscript] void addToSocket ( PRInt32 family , char* host , PRInt32 port , char* proxyHost , PRInt32 proxyPort , PRUint32 flags , PRFileDescStar* fileDesc , out nsISupports securityInfo ) [noscript] void newSocket ( PRInt32 family , char* host , PRInt32 port , char* proxyHost , PRInt32 proxyPort , PRUint32 flags , out PRFileDescStar* fileDesc , out nsISupports securityInfo )

void addToSocket ( PRInt32 family , char* host , PRInt32 port , char* proxyHost , PRInt32 proxyPort , PRUint32 flags , PRFileDescStar* fileDesc , out nsISupports securityInfo )

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 fileDesc, which is an in-param instead.

Arguments:
family
host
port
proxyHost
proxyPort
flags
fileDesc
securityInfo

void newSocket ( PRInt32 family , char* host , PRInt32 port , char* proxyHost , PRInt32 proxyPort , PRUint32 flags , out PRFileDescStar* fileDesc , out nsISupports securityInfo )

Arguments:
family: The address family for this socket (PR_AF_INET or PR_AF_INET6).
host: The hostname for this connection.
port: The port for this connection.
proxyHost: If non-null, the proxy hostname for this connection.
proxyPort: The proxy port for this connection.
flags: Control flags that govern this connection (see below.)
fileDesc: The resulting PRFileDesc.
securityInfo: Any security info that should be associated with fileDesc. This object typically implements nsITransportSecurityInfo.

References

This interface is returned from the following methods:

nsISocketProviderService.getSocketProvider

Reference documentation is generated from Mozilla's source.