Typedef for QFlags<SocketOption> which contains an OR combination of SocketOption values.

Refer to QLocalServer::SocketOption for the enum documentation.

This enum describes the possible options that can be used to create the socket. This changes the access permissions on platforms (Linux, Windows) that support access permissions on the socket. Both GroupAccess and OtherAccess may vary slightly in meanings depending on the platform.

Create a new local socket server with the given parent.

See also

listen()

Destroys the QLocalServer object. If the server is listening for connections, it is automatically closed.

Any client QLocalSockets that are still connected must either disconnect or be reparented before the server is deleted.

See also

close()

Stop listening for incoming connections. Existing connections are not effected, but any new connections will be refused.

See also

isListening(), listen()

Returns the human readable message appropriate to the current error reported by serverError(). If no suitable string is available, an empty string is returned.

See also

serverError()

Returns the full path that the server is listening on.

This method is platform specific

See also

listen(), serverName()

Returns true if the server has a pending connection, otherwise returns false.

See also

nextPendingConnection(), setMaxPendingConnections()

This virtual function is called by QLocalServer when a new connection is available. socketDescriptor is the native socket descriptor for the accepted connection.

The base implementation creates a QLocalSocket, sets the socket descriptor and then stores the QLocalSocket in an internal list of pending connections. Finally newConnection() is emitted.

Reimplement this function to alter the server's behavior when a connection is available.

See also

newConnection(), nextPendingConnection(), QLocalSocket::setSocketDescriptor()

Returns true if the server is listening for incoming connections otherwise false.

See also

close(), listen()

Tells the server to listen for incoming connections on name. If the server is currently listening then it will return false. Return true on success otherwise false.

name can be a single name and QLocalServer will determine the correct platform specific path. serverName() will return the name that is passed into listen.

Usually you would just pass in a name like "foo" but on Unix this could also be a path such as "/tmp/foo" and on Windows this could be a pipe path such as "\\.\\pipe\\foo".

On Unix if the server crashes without closing listen will fail with AddressInUseError. To create a new server the file should be removed. On Windows two local servers can listen to the same pipe at the same time, but any connections will go to one of the server.

See also

close(), isListening(), serverName()

Instructs the server to listen for incoming connections on socketDescriptor. The property returns false if the server is currently listening. It returns true on success, otherwise it returns false. The socket must be ready to accept new connections with no extra platform-specific functions called. The socket is set into non-blocking mode.

The methods serverName(), fullServerName() may return a string with a name if this option is supported by the platform, otherwise, they return an empty QString.

See also

close(), isListening()

Returns the maximum number of pending accepted connections. The default is 30.

See also

hasPendingConnections(), setMaxPendingConnections()

This signal is emitted every time a new connection is available.

See also

hasPendingConnections(), nextPendingConnection()

Returns the next pending connection as a connected QLocalSocket object. Returns 0 if this method is called when there are no pending connections.

The socket is created as a child of the server, which means that it is automatically deleted when the QLocalServer object is destroyed. It is still a good idea to delete the object explicitly when you are done with it, to avoid wasting memory.

See also

hasPendingConnections(), newConnection(), incomingConnection()

Removes any server instance that might cause a call to listen() to fail and returns true if successful, otherwise returns false. This function is meant to recover from a crash, when the previous server instance has not been cleaned up.

On Windows this method does nothing. On Unix it removes the socket file given by name.

Warning

Be careful to avoid removing sockets of running instances.

Returns the type of error that occurred last or NoError.

See also

errorString()

Returns the server name if the server is listening for connections, otherwise returns QString.

See also

listen(), fullServerName()

Sets the maximum number of pending accepted connections to numConnections. QLocalServer will accept no more than numConnections incoming connections before nextPendingConnection() is called.

Even though QLocalServer will stop accepting new connections after it has reached its maximum number of pending connections, the operating system may still keep them in queue which will result in clients signaling that it is connected.

See also

maxPendingConnections(), hasPendingConnections()

Set the socket options on the socket.

See also

QLocalServer::socketOptions

Returns the socket options set on the socket.

See also

QLocalServer::socketOptions

Waits for at most msec milliseconds or until an incoming connection is available. Returns true if a connection is available, otherwise returns false. If the operation timed out and timedOut is not 0, *timedOut will be set to true.

This is a blocking function call. Its use is ill-advised in a single-threaded GUI application, since the whole application will stop responding until the function returns. waitForNewConnection() is mostly useful when there is no event loop available.

The non-blocking alternative is to connect to the newConnection() signal.

If msec is -1, this function will not time out.

See also

hasPendingConnections(), nextPendingConnection()

The setSocketOptions method controls how the socket operates. For example the socket may restrict access to what user ids can connect to the socket.

These options must be set before listen() is called.

In some cases, such as with Unix domain sockets on Linux, the access to the socket will be determined by file system permissions, and are created based on the umask. Setting the access flags will override this and will restrict or permit access as specified.

Other Unix-based operating systems, such as OS X, do not honor file permissions for Unix domain sockets and by default have WorldAccess and these permission flags will have no effect.

On Windows, UserAccessOption is sufficient to allow a non elevated process to connect to a local server created by an elevated process run by the same user. GroupAccessOption refers to the primary group of the process (see TokenPrimaryGroup in the Windows documentation). OtherAccessOption refers to the well known "Everyone" group.

By default none of the flags are set, access permissions are the platform default.

See also

listen()