nsIServerSocket An interface to a server socket that can accept incoming connections.
[scriptable, uuid(a5b64be0-d563-46bb-ae95-132e46fcd42f)]
Attributes
Methods
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.
@param aListener
The 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.
init
This method initializes a server socket.
@param aPort
The port of the server socket. Pass -1 to indicate no preference,
and a port will be selected automatically.
@param aLoopbackOnly
If 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.
@param aBackLog
The 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.
initWithAddress
This method initializes a server socket, and binds it to a particular
local address (and hence a particular local network interface).
@param aAddr
The address to which this server socket should be bound.
@param aBackLog
The 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.
