Главная · Все пространства имен · Все классы · Основные классы · Классы по группам · Модули · Функции

QLocalSocket Class Reference
[Модуль QtNetwork]

The QLocalSocket class provides a local socket. Далее...

 #include <QLocalSocket>

Унаследован от QIODevice.

Этот класс был введён в Qt 4.4.

• Список всех членов, включая унаследованные

Открытые типы

• enum LocalSocketError { ConnectionRefusedError, PeerClosedError, ServerNotFoundError, SocketAccessError, ..., UnknownSocketError }
• enum LocalSocketState { UnconnectedState, ConnectingState, ConnectedState, ClosingState }

Открытые функции

• QLocalSocket ( QObject * parent = 0 )
• ~QLocalSocket ()
• void abort ()
• void connectToServer ( const QString & name, OpenMode openMode = ReadWrite )
• void disconnectFromServer ()
• LocalSocketError error () const
• bool flush ()
• QString fullServerName () const
• bool isValid () const
• qint64 readBufferSize () const
• QString serverName () const
• void setReadBufferSize ( qint64 size )
• bool setSocketDescriptor ( quintptr socketDescriptor, LocalSocketState socketState = ConnectedState, OpenMode openMode = ReadWrite )
• quintptr socketDescriptor () const
• LocalSocketState state () const
• bool waitForConnected ( int msec = 30000 )
• bool waitForDisconnected ( int msecs = 30000 )
• virtual bool waitForReadyRead ( int msecs = 30000 )

• 32 открытые функции, унаследованные от QIODevice
• 29 открытых функций, унаследованных от QObject

Сигналы

• void connected ()
• void disconnected ()
• void error ( QLocalSocket::LocalSocketError socketError )
• void stateChanged ( QLocalSocket::LocalSocketState socketState )

• 4 сигнала, унаследованных от QIODevice
• 1 сигнал, унаследованный от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject
• 5 статических открытых членов, унаследованных от QObject
• 5 защищенных функций, унаследованных от QIODevice
• 7 защищенных функций, унаследованных от QObject

Подробное описание

The QLocalSocket class provides a local socket.

On Windows this is a named pipe and on Unix this this is a local domain socket.

If an error occurs, socketError() returns the type of error, and errorString() can be called to get a human readable description of what happened.

Although QLocalSocket is designed for use with an event loop, it's possible to use it without one. In that case, you must use waitForConnected(), waitForReadyRead(), waitForBytesWritten(), and waitForDisconnected() which blocks until the operation is complete or the timeout expires.

Note that this feature is not supported on Window 9x or Windows CE.

See also QLocalServer.

Описание типов-членов

enum QLocalSocket::LocalSocketError

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

enum QLocalSocket::LocalSocketState

Это перечисление описывает различные состояния сокета.

See also QLocalSocket::state().

Описание функций-членов

QLocalSocket::QLocalSocket ( QObject * parent = 0 )

Creates a new local socket. The parent argument is passed to QObject's constructor.

QLocalSocket::~QLocalSocket ()

Destroys the socket, closing the connection if necessary.

void QLocalSocket::abort ()

Закрывает текущее соединение и перезагружает сокет. Unlike disconnectFromServer(), this function immediately closes the socket, clearing any pending data in the write buffer.

See also disconnectFromServer() and close().

void QLocalSocket::connectToServer ( const QString & name, OpenMode openMode = ReadWrite )

Attempts to make a connection to name.

The socket is opened in the given openMode and first enters ConnectingState. Затем он пытается соединиться по адресу, полученному в результате поиска. Finally, if a connection is established, QLocalSocket enters ConnectedState and emits connected().

На любом шаге сокет может отправить сигнал об ошибке error().

See also state(), serverName(), and waitForConnected().

void QLocalSocket::connected ()   [signal]

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

See also connectToServer() and disconnected().

void QLocalSocket::disconnectFromServer ()

Попытка закрыть сокет. 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().

void QLocalSocket::disconnected ()   [signal]

Этот сигнал посылается, когда сокет разрывает соединение.

See also connectToServer(), disconnectFromServer(), abort(), and connected().

LocalSocketError QLocalSocket::error () const

Возвращает тип последней произошедшей ошибки.

Смотрите также state() и errorString().

void QLocalSocket::error ( QLocalSocket::LocalSocketError socketError )   [signal]

Это перегруженная функция, предоставленная для удобства.

Этот сигнал посылается после того, как произошла ошибка. Параметр socketError описывает тип ошибки.

QLocalSocket::LocalSocketError is not a registered metatype, so for queued connections, you will have to register it with Q_DECLARE_METATYPE.

Смотрите также error() и errorString().

bool QLocalSocket::flush ()

This function writes as much as possible from the internal write buffer to the socket, without blocking. Если данные были записаны, функция вернёт true; в противном случае возвращается false.

Call this function if you need QLocalSocket to start sending buffered data immediately. Число переданный байт будет зависеть от операционной системы. 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. Если этого не происходит, лучше вызывайте waitForBytesWritten() вместо текущей функции.

Смотрите также write() и waitForBytesWritten().

QString QLocalSocket::fullServerName () const

Returns the server path that the socket is connected to.

Note: This is platform specific

See also connectToServer() and serverName().

bool QLocalSocket::isValid () const

Возвращает true, если сокет корректен и готов к использованию; в противном случае возвращает false.

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

Смотрите также state().

qint64 QLocalSocket::readBufferSize () const

Возвращает размер внутреннего буфера чтения. Это ограничение определяет, какой объём данных может получить клиент, прежде чем вы вызовите read() или readAll(). Размер, равный 0 (по умолчанию), означает, что буфер не ограничен, что позволяет быть уверенным в том, что данные не потеряются.

Смотрите также setReadBufferSize() и read().

QString QLocalSocket::serverName () const

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() and fullServerName().

void QLocalSocket::setReadBufferSize ( qint64 size )

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

If the buffer size is limited to a certain size, QLocalSocket won't buffer more than this size of data. В частности, если размер буфер установлен как 0, предел не установлен, все поступающие данные буферизируются. Это значение по умолчанию.

Эта опция полезна, если вы хотите только читать данные в определённое время (например, в случае с потоковым приложением реального времени) или вы хотите защитить сокет от переполнения, что может привести к нехватке памяти.

Смотрите также readBufferSize() и read().

bool QLocalSocket::setSocketDescriptor ( quintptr socketDescriptor, LocalSocketState socketState = ConnectedState, OpenMode openMode = ReadWrite )

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(), and openMode().

quintptr QLocalSocket::socketDescriptor () const

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.

Смотрите также setSocketDescriptor().

LocalSocketState QLocalSocket::state () const

Возвращает состояние сокета.

Смотрите также error().

void QLocalSocket::stateChanged ( QLocalSocket::LocalSocketState socketState )   [signal]

This signal is emitted whenever QLocalSocket's state changes. Параметр socketState является новым состоянием.

QLocalSocket::SocketState is not a registered metatype, so for queued connections, you will have to register it with Q_DECLARE_METATYPE.

Смотрите также state().

bool QLocalSocket::waitForConnected ( int msec = 30000 )

Waits until the socket is connected, up to msec milliseconds. Если соединение установлено, возвращает true; если нет - false. В случае, если функция возвращает false, вы можете вызвать error() для определения, что за ошибка произошла.

Следующий пример ждёт одну секунду для установления соединения:

 socket->connectToServer("market");
 if (socket->waitForConnected(1000))
     qDebug("Соединено!");

Если задать время тайм-аута как -1, таймер будет отключён.

See also connectToServer() and connected().

bool QLocalSocket::waitForDisconnected ( int msecs = 30000 )

Ждёт msecs миллисекунд, пока сокет разорвёт соединение. Если соединение разорвано, функция возвращает true; если нет - false. В случае, если функция возвращает false, вы можете вызвать error() для определения, что за ошибка произошла.

Следующий пример ждёт до разрыва соединения одну секунду:

 socket->disconnectFromServer();
 if (socket->waitForDisconnected(1000))
     qDebug("Отсоединено!");

Если задать время тайм-аута как -1, таймер будет отключён.

See also disconnectFromServer() and close().

bool QLocalSocket::waitForReadyRead ( int msecs = 30000 )   [virtual]

Эта функция блокирует сокет, пока данные, доступные для чтения, не будут прочитаны с помощью readyRead() и соответствующий сигнал не будет послан. Эта функция имеет тайм-аут после msecs миллисекунд; по умолчанию тайм-аут равен 30000 мс.

Функция возвращает true, если данные доступны для чтения; в противном случае возвращается false (если произошла ошибка или прошло время таймаута).

Переопределено из QIODevice.

Смотрите также waitForBytesWritten().