KLayout Manual: Main Index » Class Index » API reference - Class QLocalSocket

API reference - Class QLocalSocket

Notation used in Ruby API documentation

Description: Binding of QLocalSocket

Class hierarchy: QLocalSocket » QIODevice » QObject

Sub-classes: LocalSocketError, LocalSocketState

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QLocalSocket_LocalSocketState ptr ClosingState

Description: Enum constant QLocalSocket::ClosingState

[static,const] new QLocalSocket_LocalSocketState ptr ConnectedState

Description: Enum constant QLocalSocket::ConnectedState

[static,const] new QLocalSocket_LocalSocketState ptr ConnectingState

Description: Enum constant QLocalSocket::ConnectingState

[static,const] new QLocalSocket_LocalSocketError ptr ConnectionError

Description: Enum constant QLocalSocket::ConnectionError

[static,const] new QLocalSocket_LocalSocketError ptr ConnectionRefusedError

Description: Enum constant QLocalSocket::ConnectionRefusedError

[static,const] new QLocalSocket_LocalSocketError ptr DatagramTooLargeError

Description: Enum constant QLocalSocket::DatagramTooLargeError

[static,const] new QLocalSocket_LocalSocketError ptr PeerClosedError

Description: Enum constant QLocalSocket::PeerClosedError

[static,const] new QLocalSocket_LocalSocketError ptr ServerNotFoundError

Description: Enum constant QLocalSocket::ServerNotFoundError

[static,const] new QLocalSocket_LocalSocketError ptr SocketAccessError

Description: Enum constant QLocalSocket::SocketAccessError

[static,const] new QLocalSocket_LocalSocketError ptr SocketResourceError

Description: Enum constant QLocalSocket::SocketResourceError

[static,const] new QLocalSocket_LocalSocketError ptr SocketTimeoutError

Description: Enum constant QLocalSocket::SocketTimeoutError

[static,const] new QLocalSocket_LocalSocketState ptr UnconnectedState

Description: Enum constant QLocalSocket::UnconnectedState

[static,const] new QLocalSocket_LocalSocketError ptr UnknownSocketError

Description: Enum constant QLocalSocket::UnknownSocketError

[static,const] new QLocalSocket_LocalSocketError ptr UnsupportedSocketOperationError

Description: Enum constant QLocalSocket::UnsupportedSocketOperationError

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

void abort

Description: Method void QLocalSocket::abort()

[event] void aboutToClose

Description: Signal declaration for QLocalSocket::aboutToClose()

You can bind a procedure to this signal.

[const] long long bytesAvailable

Description: Method qint64 QLocalSocket::bytesAvailable()

This is a reimplementation of QIODevice::bytesAvailable

[const] long long bytesToWrite

Description: Method qint64 QLocalSocket::bytesToWrite()

This is a reimplementation of QIODevice::bytesToWrite

[event] void bytesWritten(long long bytes)

Description: Signal declaration for QLocalSocket::bytesWritten(qint64 bytes)

You can bind a procedure to this signal.

[const] bool canReadLine

Description: Method bool QLocalSocket::canReadLine()

This is a reimplementation of QIODevice::canReadLine

void close

Description: Method void QLocalSocket::close()

This is a reimplementation of QIODevice::close

void connectToServer(string name,const QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method void QLocalSocket::connectToServer(const QString &name, QFlags<QIODevice::OpenModeFlag> openMode)

[event] void connected

Description: Signal declaration for QLocalSocket::connected()

You can bind a procedure to this signal.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QLocalSocket::destroyed(QObject *)

You can bind a procedure to this signal.

void disconnectFromServer

Description: Method void QLocalSocket::disconnectFromServer()

[event] void disconnected

Description: Signal declaration for QLocalSocket::disconnected()

You can bind a procedure to this signal.

[const] QLocalSocket_LocalSocketError error

Description: Method QLocalSocket::LocalSocketError QLocalSocket::error()

[event] void error(const QLocalSocket_LocalSocketError socketError)

Description: Signal declaration for QLocalSocket::error(QLocalSocket::LocalSocketError socketError)

You can bind a procedure to this signal.

bool flush

Description: Method bool QLocalSocket::flush()

[const] string fullServerName

Description: Method QString QLocalSocket::fullServerName()

[const] bool isSequential?

Description: Method bool QLocalSocket::isSequential()

This is a reimplementation of QIODevice::isSequential

[const] bool isValid?

Description: Method bool QLocalSocket::isValid()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[static] new QLocalSocket new(QObject ptr parent = 0)

Description: Constructor QLocalSocket::QLocalSocket(QObject *parent)

This method creates an object of class QLocalSocket.

Python specific notes:

This method is the default initializer of the object

[const] long long readBufferSize

Description: Method qint64 QLocalSocket::readBufferSize()

Python specific notes:

The object exposes a readable attribute 'readBufferSize'. This is the getter.

void readBufferSize=(long long size)

Description: Method void QLocalSocket::setReadBufferSize(qint64 size)

Python specific notes:

The object exposes a writable attribute 'readBufferSize'. This is the setter.

[event] void readChannelFinished

Description: Signal declaration for QLocalSocket::readChannelFinished()

You can bind a procedure to this signal.

[event] void readyRead

Description: Signal declaration for QLocalSocket::readyRead()

You can bind a procedure to this signal.

[const] string serverName

Description: Method QString QLocalSocket::serverName()

void setReadBufferSize(long long size)

Description: Method void QLocalSocket::setReadBufferSize(qint64 size)

Python specific notes:

The object exposes a writable attribute 'readBufferSize'. This is the setter.

bool setSocketDescriptor(unsigned long long socketDescriptor,const QLocalSocket_LocalSocketState socketState = QLocalSocket::ConnectedState,const QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method bool QLocalSocket::setSocketDescriptor(quintptr socketDescriptor, QLocalSocket::LocalSocketState socketState, QFlags<QIODevice::OpenModeFlag> openMode)

[const] unsigned long long socketDescriptor

Description: Method quintptr QLocalSocket::socketDescriptor()

[const] QLocalSocket_LocalSocketState state

Description: Method QLocalSocket::LocalSocketState QLocalSocket::state()

[event] void stateChanged(const QLocalSocket_LocalSocketState socketState)

Description: Signal declaration for QLocalSocket::stateChanged(QLocalSocket::LocalSocketState socketState)

You can bind a procedure to this signal.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[static] string tr(string s,string c = 0)

Description: Static method QString QLocalSocket::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QLocalSocket::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QLocalSocket::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QLocalSocket::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

bool waitForBytesWritten(int msecs = 30000)

Description: Method bool QLocalSocket::waitForBytesWritten(int msecs)

This is a reimplementation of QIODevice::waitForBytesWritten

bool waitForConnected(int msecs = 30000)

Description: Method bool QLocalSocket::waitForConnected(int msecs)

bool waitForDisconnected(int msecs = 30000)

Description: Method bool QLocalSocket::waitForDisconnected(int msecs)

bool waitForReadyRead(int msecs = 30000)

Description: Method bool QLocalSocket::waitForReadyRead(int msecs)

This is a reimplementation of QIODevice::waitForReadyRead