Back to index

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

nsIServerSocket More...

import "nsIServerSocket.idl";

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

List of all members.

Public Member Functions

void init (in long aPort, in boolean aLoopbackOnly, in long aBackLog)
 init
void initWithAddress ([const ] in PRNetAddrPtr aAddr, in long aBackLog)
 initWithAddress
void close ()
 close
void asyncListen (in nsIServerSocketListener aListener)
 asyncListen
PRNetAddr getAddress ()
 Returns the address to which this server socket is bound.

Public Attributes

readonly attribute long port
 Returns the port of this server socket.

Detailed Description

nsIServerSocket

An interface to a server socket that can accept incoming connections.

Definition at line 52 of file nsIServerSocket.idl.


Member Function Documentation

asyncListen

This method puts the server socket in the listening state. It will asynchronously listen for and accept client connections. The listener will be notified once for each client connection that is accepted. The listener's onSocketAccepted method will be called on the same thread that called asyncListen (the calling thread must have a nsIEventTarget).

The listener will be passed a reference to an already connected socket transport (nsISocketTransport). See below for more details.

Parameters:
aListenerThe listener to be notified when client connections are accepted.

close

This method closes a server socket. This does not affect already connected client sockets (i.e., the nsISocketTransport instances created from this server socket). This will cause the onStopListening event to asynchronously fire with a status of NS_BINDING_ABORTED.

Returns the address to which this server socket is bound.

Since a server socket may be bound to multiple network devices, this address may not necessarily be specific to a single network device. In the case of an IP socket, the IP address field would be zerod out to indicate a server socket bound to all network devices. Therefore, this method cannot be used to determine the IP address of the local system. See nsIDNSService::myHostName if this is what you need.

void nsIServerSocket::init ( in long  aPort,
in boolean  aLoopbackOnly,
in long  aBackLog 
)

init

This method initializes a server socket.

Parameters:
aPortThe port of the server socket. Pass -1 to indicate no preference, and a port will be selected automatically.
aLoopbackOnlyIf true, the server socket will only respond to connections on the local loopback interface. Otherwise, it will accept connections from any interface. To specify a particular network interface, use initWithAddress.
aBackLogThe maximum length the queue of pending connections may grow to. This parameter may be silently limited by the operating system. Pass -1 to use the default value.
void nsIServerSocket::initWithAddress ( [const ] in PRNetAddrPtr  aAddr,
in long  aBackLog 
)

initWithAddress

This method initializes a server socket, and binds it to a particular local address (and hence a particular local network interface).

Parameters:
aAddrThe address to which this server socket should be bound.
aBackLogThe maximum length the queue of pending connections may grow to. This parameter may be silently limited by the operating system. Pass -1 to use the default value.

Member Data Documentation

Returns the port of this server socket.

Definition at line 119 of file nsIServerSocket.idl.


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