Readonly portReturns the port of this server socket.
Optional aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
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.
The listener to be notified when client connections are accepted.
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.
The port of the server socket. Pass -1 to indicate no preference, and a port will be selected automatically.
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.
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.
initSpecialConnection
This method initializes a server socket and offers the ability to have that socket not get terminated if Gecko is set offline.
The port of the server socket. Pass -1 to indicate no preference, and a port will be selected automatically.
Flags for the socket.
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.
initWithAbstractAddress
This mehtod is a flavor of initWithFilename method. This initializes a UNIX domain socket that uses abstract socket address. This socket type is only supported on Linux and Android.
On systems that don't support this type's UNIX domain sockets at all, this returns NS_ERROR_SOCKET_ADDRESS_NOT_SUPPORTED.
The abstract socket address which the socket should be created.
The maximum length the queue of pending connections may grow to.
initWithAddress
This method initializes a server socket, and binds it to a particular local address (and hence a particular local network interface).
The address to which this server socket should be bound.
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.
initWithFilename
This method initializes a Unix domain or "local" server socket. Such a socket has a name in the filesystem, like an ordinary file. To connect, a client supplies the socket's filename, and the usual permission checks on socket apply.
This makes Unix domain sockets useful for communication between the programs being run by a specific user on a single machine: the operating system takes care of authentication, and the user's home directory or profile directory provide natural per-user rendezvous points.
Since Unix domain sockets are always local to the machine, they are not affected by the nsIIOService's 'offline' flag.
The system-level socket API may impose restrictions on the length of the filename that are stricter than those of the underlying filesystem. If the file name is too long, this returns NS_ERROR_FILE_NAME_TOO_LONG.
All components of the path prefix of |aPath| must name directories; otherwise, this returns NS_ERROR_FILE_NOT_DIRECTORY.
This call requires execute permission on all directories containing the one in which the socket is to be created, and write and execute permission on the directory itself. Otherwise, this returns NS_ERROR_CONNECTION_REFUSED.
This call creates the socket's directory entry. There must not be any existing entry with the given name. If there is, this returns NS_ERROR_SOCKET_ADDRESS_IN_USE.
On systems that don't support Unix domain sockets at all, this returns NS_ERROR_SOCKET_ADDRESS_NOT_SUPPORTED.
nsIFile The file name at which the socket should be created.
unsigned long Unix-style permission bits to be applied to the new socket.
Note about permissions: Linux's unix(7) man page claims that some BSD-derived systems ignore permissions on UNIX-domain sockets; NetBSD's bind(2) man page agrees, but says it does check now (dated 2005). POSIX has required 'connect' to fail if write permission on the socket itself is not granted since 2003 (Issue 6). NetBSD says that the permissions on the containing directory (execute) have always applied, so creating sockets in appropriately protected directories should be secure on both old and new systems.
Generated using TypeDoc
nsIServerSocket
An interface to a server socket that can accept incoming connections.