Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsISocketProvider Interface Reference

nsISocketProvider More...

import "nsISocketProvider.idl";

Inheritance diagram for nsISocketProvider:
Inheritance graph
[legend]
Collaboration diagram for nsISocketProvider:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void newSocket (in long aFamily, in string aHost, in long aPort, in string aProxyHost, in long aProxyPort, in unsigned long aFlags, out PRFileDescStar aFileDesc, out nsISupports aSecurityInfo)
 newSocket
void addToSocket (in long aFamily, in string aHost, in long aPort, in string aProxyHost, in long aProxyPort, in unsigned long aFlags, in PRFileDescStar aFileDesc, out nsISupports aSecurityInfo)
 addToSocket

Public Attributes

const long PROXY_RESOLVES_HOST = 1 << 0
 PROXY_RESOLVES_HOST.

Detailed Description

nsISocketProvider

Definition at line 47 of file nsISocketProvider.idl.


Member Function Documentation

void nsISocketProvider::addToSocket ( in long  aFamily,
in string  aHost,
in long  aPort,
in string  aProxyHost,
in long  aProxyPort,
in unsigned long  aFlags,
in PRFileDescStar  aFileDesc,
out nsISupports  aSecurityInfo 
)

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.

void nsISocketProvider::newSocket ( in long  aFamily,
in string  aHost,
in long  aPort,
in string  aProxyHost,
in long  aProxyPort,
in unsigned long  aFlags,
out PRFileDescStar  aFileDesc,
out nsISupports  aSecurityInfo 
)

newSocket

Parameters:
aFamilyThe address family for this socket (PR_AF_INET or PR_AF_INET6).
aHostThe hostname for this connection.
aPortThe port for this connection.
aProxyHostIf non-null, the proxy hostname for this connection.
aProxyPortThe proxy port for this connection.
aFlagsControl flags that govern this connection (see below.)
aFileDescThe resulting PRFileDesc.
aSecurityInfoAny security info that should be associated with aFileDesc. This object typically implements nsITransportSecurityInfo.

Member Data Documentation

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.

Definition at line 108 of file nsISocketProvider.idl.


The documentation for this interface was generated from the following file: