The LocalServerError enumeration represents the errors that can occur. The most recent error can be retrieved through a call to QLocalSocket::error().

This enum describes the different states in which a socket can be.

See also

QLocalSocket::state()

Creates a new local socket. The parent object is passed to the QObject constructor.

Destroys the socket, closing the connection if necessary.

Aborts the current connection and resets the socket. Unlike disconnectFromServer(), this function immediately closes the socket, clearing any pending data in the write buffer.

See also

disconnectFromServer(), close()

Reimplemented from QIODevice::bytesAvailable()

Reimplemented from QIODevice::bytesToWrite()

Reimplemented from QIODevice::canReadLine()

Reimplemented from QIODevice::close()

This signal is emitted after connectToServer() has been called and a connection has been successfully established.

See also

connectToServer(), disconnected()

Set the server name and attempts to make a connection to it.

The socket is opened in the given openMode and first enters ConnectingState. If a connection is established, QLocalSocket enters ConnectedState and emits connected().

After calling this method the socket can emit error() to signal that an error occurred.

See also

state(), serverName(), waitForConnected()

Attempts to make a connection to serverName(). setServerName() must be called before you open the connection. Alternatively you can use connectToServer(const QString &name, OpenMode openMode);

The socket is opened in the given openMode and first enters ConnectingState. If a connection is established, QLocalSocket enters ConnectedState and emits connected().

After calling this method the socket can emit error() to signal that an error occurred.

See also

state(), serverName(), waitForConnected()

This signal is emitted when the socket has been disconnected.

See also

connectToServer(), disconnectFromServer(), abort(), connected()

Attempts to close the socket. If there is pending data waiting to be written, QLocalSocket will enter ClosingState and wait until all data has been written. Eventually, it will enter UnconnectedState and emit the disconnectedFromServer() signal.

See also

connectToServer()

Returns the type of error that last occurred.

See also

state(), errorString()

This signal is emitted after an error occurred. The socketError parameter describes the type of error that occurred.

See also

error(), errorString(), Creating Custom Types

This function writes as much as possible from the internal write buffer to the socket, without blocking. If any data was written, this function returns true, otherwise false is returned.

Call this function if you need QLocalSocket to start sending buffered data immediately. The number of bytes successfully written depends on the operating system. In most cases, you do not need to call this function, because QLocalSocket will start sending data automatically once control goes back to the event loop. In the absence of an event loop, call waitForBytesWritten() instead.

See also

write(), waitForBytesWritten()

Returns the server path that the socket is connected to.

Note

The return value of this function is platform specific.

See also

connectToServer(), serverName()

Reimplemented from QIODevice::isSequential()

Returns true if the socket is valid and ready for use, otherwise returns false.

Note

The socket's state must be ConnectedState before reading and writing can occur.

See also

state(), connectToServer()

Opens the device and sets its OpenMode to mode. Returns true if successful, otherwise returns false. This method should be called from any existing reimplementation of open() or other functions that open the device.

See also

openMode(), OpenMode

Reimplemented from QIODevice::open()

Returns the size of the internal read buffer. This limits the amount of data that the client can receive before you call read() or readAll(). A read buffer size of 0 (the default) means that the buffer has no size limit, ensuring that no data is lost.

See also

setReadBufferSize(), read()

Implements QIODevice::readData()

Returns the name of the peer as specified by connectToServer(), or an empty QString if connectToServer() has not been called or it failed.

See also

connectToServer(), fullServerName()

Sets the size of QLocalSocket's internal read buffer to be size bytes.

If the buffer size is limited to a certain size, QLocalSocket will not buffer more than this size of data. Exceptionally, a buffer size of 0 means that the read buffer is unlimited and all incoming data is buffered. This is the default.

This option is useful if you only read the data at certain points in time (e.g., in a real-time streaming application) or if you want to protect your socket against receiving too much data, which may eventually cause your application to run out of memory.

See also

readBufferSize(), read()

Initializes QLocalSocket with the native socket descriptor socketDescriptor. Returns true if socketDescriptor is accepted as a valid socket descriptor, otherwise returns false. The socket is opened in the mode specified by openMode, and enters the socket state specified by socketState.

Note

It is not possible to initialize two local sockets with the same native socket descriptor.

See also

socketDescriptor(), state(), openMode()

Returns the native socket descriptor of the QLocalSocket object if this is available, otherwise returns -1.

The socket descriptor is not available when QLocalSocket is in UnconnectedState.

See also

setSocketDescriptor()

Returns the state of the socket.

See also

error()

This signal is emitted whenever QLocalSocket's state changes. The socketState parameter is the new state.

See also

state(), Creating Custom Types

Reimplemented from QIODevice::waitForBytesWritten()

Waits until the socket is connected, up to msecs milliseconds. If the connection has been established, this function returns true, otherwise it returns false. In the case where it returns false, you can call error() to determine the cause of the error.

The following example waits up to one second for a connection to be established:

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

See also

connectToServer(), connected()

Waits until the socket has disconnected, up to msecs milliseconds. If the connection has been disconnected, this function returns true, otherwise it returns false. In the case where it returns false, you can call error() to determine the cause of the error.

The following example waits up to one second for a connection to be closed:

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

See also

disconnectFromServer(), close()

This method blocks until data is available for reading and the readyRead() signal has been emitted. This method will timeout after msecs milliseconds; the default timeout is 30000 milliseconds. Returns true if data is available for reading, otherwise it returns false (if an error occurred or the operation timed out).

See also

waitForBytesWritten()

Reimplemented from QIODevice::waitForReadyRead()

Implements QIODevice::writeData()