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

Public constructors

new QLocalSocketnewConstructor QLocalSocket::QLocalSocket(QObject *parent)
new QLocalSocketnew(QObject ptr parent)Constructor QLocalSocket::QLocalSocket(QObject *parent)

Public methods

voidabortMethod void QLocalSocket::abort()
[const]long longbytesAvailableMethod qint64 QLocalSocket::bytesAvailable()
[const]long longbytesToWriteMethod qint64 QLocalSocket::bytesToWrite()
[const]boolcanReadLineMethod bool QLocalSocket::canReadLine()
voidcloseMethod void QLocalSocket::close()
voidconnectToServer(string name)Method void QLocalSocket::connectToServer(const QString &name, QFlags<enum QIODevice::OpenModeFlag> openMode)
voidconnectToServer(string name,
int openMode)		Method void QLocalSocket::connectToServer(const QString &name, QFlags<enum QIODevice::OpenModeFlag> openMode)
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
voiddisconnectFromServerMethod void QLocalSocket::disconnectFromServer()
[const]QLocalSocket_LocalSocketErrorerrorMethod QLocalSocket::LocalSocketError QLocalSocket::error()
boolflushMethod bool QLocalSocket::flush()
[const]stringfullServerNameMethod QString QLocalSocket::fullServerName()
[const]boolisSequentialMethod bool QLocalSocket::isSequential()
[const]boolisSequential?Method bool QLocalSocket::isSequential()
[const]boolisValidMethod bool QLocalSocket::isValid()
[const]boolisValid?Method bool QLocalSocket::isValid()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]long longreadBufferSizeMethod qint64 QLocalSocket::readBufferSize()
voidreadBufferSize=(long long size)Method void QLocalSocket::setReadBufferSize(qint64 size)
[const]stringserverNameMethod QString QLocalSocket::serverName()
voidsetReadBufferSize(long long size)Method void QLocalSocket::setReadBufferSize(qint64 size)
boolsetSocketDescriptor(unsigned int socketDescriptor)Method bool QLocalSocket::setSocketDescriptor(quintptr socketDescriptor, QLocalSocket::LocalSocketState socketState, QFlags<enum QIODevice::OpenModeFlag> openMode)
boolsetSocketDescriptor(unsigned int socketDescriptor,
const QLocalSocket_LocalSocketState socketState)		Method bool QLocalSocket::setSocketDescriptor(quintptr socketDescriptor, QLocalSocket::LocalSocketState socketState, QFlags<enum QIODevice::OpenModeFlag> openMode)
boolsetSocketDescriptor(unsigned int socketDescriptor,
const QLocalSocket_LocalSocketState socketState,
int openMode)		Method bool QLocalSocket::setSocketDescriptor(quintptr socketDescriptor, QLocalSocket::LocalSocketState socketState, QFlags<enum QIODevice::OpenModeFlag> openMode)
[const]unsigned intsocketDescriptorMethod quintptr QLocalSocket::socketDescriptor()
[const]QLocalSocket_LocalSocketStatestateMethod QLocalSocket::LocalSocketState QLocalSocket::state()
boolwaitForBytesWrittenMethod bool QLocalSocket::waitForBytesWritten(int msecs)
boolwaitForBytesWritten(int msecs)Method bool QLocalSocket::waitForBytesWritten(int msecs)
boolwaitForConnectedMethod bool QLocalSocket::waitForConnected(int msecs)
boolwaitForConnected(int msecs)Method bool QLocalSocket::waitForConnected(int msecs)
boolwaitForDisconnectedMethod bool QLocalSocket::waitForDisconnected(int msecs)
boolwaitForDisconnected(int msecs)Method bool QLocalSocket::waitForDisconnected(int msecs)
boolwaitForReadyReadMethod bool QLocalSocket::waitForReadyRead(int msecs)
boolwaitForReadyRead(int msecs)Method bool QLocalSocket::waitForReadyRead(int msecs)

Public static methods and constants

QLocalSocket_LocalSocketStateClosingStateEnum constant enum QLocalSocket::ClosingState
QLocalSocket_LocalSocketStateConnectedStateEnum constant enum QLocalSocket::ConnectedState
QLocalSocket_LocalSocketStateConnectingStateEnum constant enum QLocalSocket::ConnectingState
QLocalSocket_LocalSocketErrorConnectionErrorEnum constant enum QLocalSocket::ConnectionError
QLocalSocket_LocalSocketErrorConnectionRefusedErrorEnum constant enum QLocalSocket::ConnectionRefusedError
QLocalSocket_LocalSocketErrorDatagramTooLargeErrorEnum constant enum QLocalSocket::DatagramTooLargeError
QLocalSocket_LocalSocketErrorPeerClosedErrorEnum constant enum QLocalSocket::PeerClosedError
QLocalSocket_LocalSocketErrorServerNotFoundErrorEnum constant enum QLocalSocket::ServerNotFoundError
QLocalSocket_LocalSocketErrorSocketAccessErrorEnum constant enum QLocalSocket::SocketAccessError
QLocalSocket_LocalSocketErrorSocketResourceErrorEnum constant enum QLocalSocket::SocketResourceError
QLocalSocket_LocalSocketErrorSocketTimeoutErrorEnum constant enum QLocalSocket::SocketTimeoutError
QLocalSocket_LocalSocketStateUnconnectedStateEnum constant enum QLocalSocket::UnconnectedState
QLocalSocket_LocalSocketErrorUnknownSocketErrorEnum constant enum QLocalSocket::UnknownSocketError
QLocalSocket_LocalSocketErrorUnsupportedSocketOperationErrorEnum constant enum QLocalSocket::UnsupportedSocketOperationError
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s)Static method QString QLocalSocket::tr(const char *s, const char *c)
stringtr(string s,
string c)		Static method QString QLocalSocket::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)		Static method QString QLocalSocket::tr(const char *s, const char *c, int n)
stringtrUtf8(string s)Static method QString QLocalSocket::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c)		Static method QString QLocalSocket::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)		Static method QString QLocalSocket::trUtf8(const char *s, const char *c, int n)

Detailed description

[static] QLocalSocket_LocalSocketState ClosingState

Description: Enum constant enum QLocalSocket::ClosingState

[static] QLocalSocket_LocalSocketState ConnectedState

Description: Enum constant enum QLocalSocket::ConnectedState

[static] QLocalSocket_LocalSocketState ConnectingState

Description: Enum constant enum QLocalSocket::ConnectingState

[static] QLocalSocket_LocalSocketError ConnectionError

Description: Enum constant enum QLocalSocket::ConnectionError

[static] QLocalSocket_LocalSocketError ConnectionRefusedError

Description: Enum constant enum QLocalSocket::ConnectionRefusedError

[static] QLocalSocket_LocalSocketError DatagramTooLargeError

Description: Enum constant enum QLocalSocket::DatagramTooLargeError

[static] QLocalSocket_LocalSocketError PeerClosedError

Description: Enum constant enum QLocalSocket::PeerClosedError

[static] QLocalSocket_LocalSocketError ServerNotFoundError

Description: Enum constant enum QLocalSocket::ServerNotFoundError

[static] QLocalSocket_LocalSocketError SocketAccessError

Description: Enum constant enum QLocalSocket::SocketAccessError

[static] QLocalSocket_LocalSocketError SocketResourceError

Description: Enum constant enum QLocalSocket::SocketResourceError

[static] QLocalSocket_LocalSocketError SocketTimeoutError

Description: Enum constant enum QLocalSocket::SocketTimeoutError

[static] QLocalSocket_LocalSocketState UnconnectedState

Description: Enum constant enum QLocalSocket::UnconnectedState

[static] QLocalSocket_LocalSocketError UnknownSocketError

Description: Enum constant enum QLocalSocket::UnknownSocketError

[static] QLocalSocket_LocalSocketError UnsupportedSocketOperationError

Description: Enum constant enum QLocalSocket::UnsupportedSocketOperationError

void abort

Description: Method void QLocalSocket::abort()

[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

[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)

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

void connectToServer(string name,int openMode)

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

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 destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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.

void disconnectFromServer

Description: Method void QLocalSocket::disconnectFromServer()

[const] QLocalSocket_LocalSocketError error

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

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 isSequential?

Description: Method bool QLocalSocket::isSequential()

This is a reimplementation of QIODevice::isSequential

[const] bool isValid

Description: Method bool QLocalSocket::isValid()

[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

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

[static] new QLocalSocket new

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

This method creates an object of class QLocalSocket.

[static] new QLocalSocket new(QObject ptr parent)

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

This method creates an object of class QLocalSocket.

[const] long long readBufferSize

Description: Method qint64 QLocalSocket::readBufferSize()

void readBufferSize=(long long size)

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

[const] string serverName

Description: Method QString QLocalSocket::serverName()

void setReadBufferSize(long long size)

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

bool setSocketDescriptor(unsigned int socketDescriptor)

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

bool setSocketDescriptor(unsigned int socketDescriptor,const QLocalSocket_LocalSocketState socketState)

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

bool setSocketDescriptor(unsigned int socketDescriptor,const QLocalSocket_LocalSocketState socketState,int openMode)

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

[const] unsigned int socketDescriptor

Description: Method quintptr QLocalSocket::socketDescriptor()

[const] QLocalSocket_LocalSocketState state

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[static] string tr(string s)

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)

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)

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)

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

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

This is a reimplementation of QIODevice::waitForBytesWritten

bool waitForBytesWritten(int msecs)

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

This is a reimplementation of QIODevice::waitForBytesWritten

bool waitForConnected

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

bool waitForConnected(int msecs)

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

bool waitForDisconnected

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

bool waitForDisconnected(int msecs)

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

bool waitForReadyRead

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

This is a reimplementation of QIODevice::waitForReadyRead

bool waitForReadyRead(int msecs)

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

This is a reimplementation of QIODevice::waitForReadyRead