nsISocketTransport

 NOTE: This is a free-threaded interface, meaning that the methods on
 this interface may be called from any thread.
[scriptable, uuid(66418cc8-5f5d-4f52-a7f9-db8fb3b2cfe6)]
interface nsISocketTransport : nsITransport

Constants

 Values for the aType parameter passed to get/setTimeout.
const unsigned long TIMEOUT_CONNECT = 0 

          

  
  const
  
    unsigned long  
  TIMEOUT_READ_WRITE = 1

        

              

          
 nsITransportEventSink status codes.

 Although these look like XPCOM error codes and are passed in an nsresult
 variable, they are *not* error codes.  Note that while they *do* overlap
 with existing error codes in Necko, these status codes are confined
 within a very limited context where no error codes may appear, so there
 is no ambiguity.

 The values of these status codes must never change.

 The status codes appear in near-chronological order (not in numeric
 order).  STATUS_RESOLVING may be skipped if the host does not need to be
 resolved.  STATUS_WAITING_FOR is an optional status code, which the impl
 of this interface may choose not to generate.


          

  
  const
  
    unsigned long  
  STATUS_RESOLVING = 2152398851

        

              

          

          

  
  const
  
    unsigned long  
  STATUS_CONNECTING_TO = 2152398855

        

              

          

          

  
  const
  
    unsigned long  
  STATUS_CONNECTED_TO = 2152398852

        

              

          

          

  
  const
  
    unsigned long  
  STATUS_SENDING_TO = 2152398853

        

              

          

          

  
  const
  
    unsigned long  
  STATUS_WAITING_FOR = 2152398858

        

              

          

          

  
  const
  
    unsigned long  
  STATUS_RECEIVING_FROM = 2152398854

        

          

        
Attributes

    

              

          
 Get the host for the underlying socket connection.


          

  
    readonly attribute
  
    AUTF8String  
  host

        

              

          
 Get the port for the underlying socket connection.


          

  
    readonly attribute
  
    long  
  port

        

              

          
 Security notification callbacks passed to the secure socket provider
 via nsISSLSocketControl at socket creation time.

 NOTE: this attribute cannot be changed once a stream has been opened.


          

  
    attribute
  
    nsIInterfaceRequestor  
  securityCallbacks

        

              

          
 Security info object returned from the secure socket provider.  This
 object supports nsISSLSocketControl, nsITransportSecurityInfo, and
 possibly other interfaces.


          

  
    readonly attribute
  
    nsISupports  
  securityInfo

        

          

        
Methods

    

              

          
 
 Returns the IP address of the socket connection peer. This
 attribute is defined only once a connection has been established.


          

  
  [noscript]   
    PRNetAddr
  getPeerAddr()

        

              

          
 
 Returns the IP address of the initiating end. This attribute
 is defined only once a connection has been established.


          

  
  [noscript]   
    PRNetAddr
  getSelfAddr()

        

              

          
 Socket timeouts in seconds.  To specify no timeout, pass PR_UINT32_MAX
 as aValue to setTimeout.  The implementation may truncate timeout values
 to a smaller range of values (e.g., 0 to 0xFFFF).


          

  
    
    unsigned long
  getTimeout(in unsigned long aType)

        

              

          
 Test if this socket transport is (still) connected.


          

  
    
    boolean
  isAlive()

        

              

          

          

  
    
    void
  setTimeout(in unsigned long aType, in unsigned long aValue)