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

API reference - Class QAbstractSocket

Notation used in Ruby API documentation

Description: Binding of QAbstractSocket

Class hierarchy: QAbstractSocket » QIODevice » QObject

Sub-classes: NetworkLayerProtocol, SocketError, SocketOption, SocketState, SocketType

• 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 QAbstractSocket_SocketError ptr AddressInUseError

Description: Enum constant QAbstractSocket::AddressInUseError

[static,const] new QAbstractSocket_SocketState ptr BoundState

Description: Enum constant QAbstractSocket::BoundState

[static,const] new QAbstractSocket_SocketState ptr ClosingState

Description: Enum constant QAbstractSocket::ClosingState

[static,const] new QAbstractSocket_SocketState ptr ConnectedState

Description: Enum constant QAbstractSocket::ConnectedState

[static,const] new QAbstractSocket_SocketState ptr ConnectingState

Description: Enum constant QAbstractSocket::ConnectingState

[static,const] new QAbstractSocket_SocketError ptr ConnectionRefusedError

Description: Enum constant QAbstractSocket::ConnectionRefusedError

[static,const] new QAbstractSocket_SocketError ptr DatagramTooLargeError

Description: Enum constant QAbstractSocket::DatagramTooLargeError

[static,const] new QAbstractSocket_SocketState ptr HostLookupState

Description: Enum constant QAbstractSocket::HostLookupState

[static,const] new QAbstractSocket_SocketError ptr HostNotFoundError

Description: Enum constant QAbstractSocket::HostNotFoundError

[static,const] new QAbstractSocket_NetworkLayerProtocol ptr IPv4Protocol

Description: Enum constant QAbstractSocket::IPv4Protocol

[static,const] new QAbstractSocket_NetworkLayerProtocol ptr IPv6Protocol

Description: Enum constant QAbstractSocket::IPv6Protocol

[static,const] new QAbstractSocket_SocketOption ptr KeepAliveOption

Description: Enum constant QAbstractSocket::KeepAliveOption

[static,const] new QAbstractSocket_SocketState ptr ListeningState

Description: Enum constant QAbstractSocket::ListeningState

[static,const] new QAbstractSocket_SocketOption ptr LowDelayOption

Description: Enum constant QAbstractSocket::LowDelayOption

[static,const] new QAbstractSocket_SocketError ptr NetworkError

Description: Enum constant QAbstractSocket::NetworkError

[static,const] new QAbstractSocket_SocketError ptr ProxyAuthenticationRequiredError

Description: Enum constant QAbstractSocket::ProxyAuthenticationRequiredError

[static,const] new QAbstractSocket_SocketError ptr ProxyConnectionClosedError

Description: Enum constant QAbstractSocket::ProxyConnectionClosedError

[static,const] new QAbstractSocket_SocketError ptr ProxyConnectionRefusedError

Description: Enum constant QAbstractSocket::ProxyConnectionRefusedError

[static,const] new QAbstractSocket_SocketError ptr ProxyConnectionTimeoutError

Description: Enum constant QAbstractSocket::ProxyConnectionTimeoutError

[static,const] new QAbstractSocket_SocketError ptr ProxyNotFoundError

Description: Enum constant QAbstractSocket::ProxyNotFoundError

[static,const] new QAbstractSocket_SocketError ptr ProxyProtocolError

Description: Enum constant QAbstractSocket::ProxyProtocolError

[static,const] new QAbstractSocket_SocketError ptr RemoteHostClosedError

Description: Enum constant QAbstractSocket::RemoteHostClosedError

[static,const] new QAbstractSocket_SocketError ptr SocketAccessError

Description: Enum constant QAbstractSocket::SocketAccessError

[static,const] new QAbstractSocket_SocketError ptr SocketAddressNotAvailableError

Description: Enum constant QAbstractSocket::SocketAddressNotAvailableError

[static,const] new QAbstractSocket_SocketError ptr SocketResourceError

Description: Enum constant QAbstractSocket::SocketResourceError

[static,const] new QAbstractSocket_SocketError ptr SocketTimeoutError

Description: Enum constant QAbstractSocket::SocketTimeoutError

[static,const] new QAbstractSocket_SocketError ptr SslHandshakeFailedError

Description: Enum constant QAbstractSocket::SslHandshakeFailedError

[static,const] new QAbstractSocket_SocketType ptr TcpSocket

Description: Enum constant QAbstractSocket::TcpSocket

[static,const] new QAbstractSocket_SocketType ptr UdpSocket

Description: Enum constant QAbstractSocket::UdpSocket

[static,const] new QAbstractSocket_SocketState ptr UnconnectedState

Description: Enum constant QAbstractSocket::UnconnectedState

[static,const] new QAbstractSocket_SocketError ptr UnfinishedSocketOperationError

Description: Enum constant QAbstractSocket::UnfinishedSocketOperationError

[static,const] new QAbstractSocket_NetworkLayerProtocol ptr UnknownNetworkLayerProtocol

Description: Enum constant QAbstractSocket::UnknownNetworkLayerProtocol

[static,const] new QAbstractSocket_SocketError ptr UnknownSocketError

Description: Enum constant QAbstractSocket::UnknownSocketError

[static,const] new QAbstractSocket_SocketType ptr UnknownSocketType

Description: Enum constant QAbstractSocket::UnknownSocketType

[static,const] new QAbstractSocket_SocketError ptr UnsupportedSocketOperationError

Description: Enum constant QAbstractSocket::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 QAbstractSocket::abort()

[event] void aboutToClose

Description: Signal declaration for QAbstractSocket::aboutToClose()

You can bind a procedure to this signal.

[const] bool atEnd

Description: Method bool QAbstractSocket::atEnd()

This is a reimplementation of QIODevice::atEnd

[const] long long bytesAvailable

Description: Method qint64 QAbstractSocket::bytesAvailable()

This is a reimplementation of QIODevice::bytesAvailable

[const] long long bytesToWrite

Description: Method qint64 QAbstractSocket::bytesToWrite()

This is a reimplementation of QIODevice::bytesToWrite

[event] void bytesWritten(long long bytes)

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

You can bind a procedure to this signal.

[const] bool canReadLine

Description: Method bool QAbstractSocket::canReadLine()

This is a reimplementation of QIODevice::canReadLine

void close

Description: Method void QAbstractSocket::close()

This is a reimplementation of QIODevice::close

void connectToHost(string hostName,unsigned short port,const QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

Description: Method void QAbstractSocket::connectToHost(const QString &hostName, quint16 port, QFlags<QIODevice::OpenModeFlag> mode)

void connectToHost(const QHostAddress address,unsigned short port,const QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

Description: Method void QAbstractSocket::connectToHost(const QHostAddress &address, quint16 port, QFlags<QIODevice::OpenModeFlag> mode)

[event] void connected

Description: Signal declaration for QAbstractSocket::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 QAbstractSocket::destroyed(QObject *)

You can bind a procedure to this signal.

void disconnectFromHost

Description: Method void QAbstractSocket::disconnectFromHost()

[event] void disconnected

Description: Signal declaration for QAbstractSocket::disconnected()

You can bind a procedure to this signal.

[const] QAbstractSocket_SocketError error

Description: Method QAbstractSocket::SocketError QAbstractSocket::error()

[event] void error(const QAbstractSocket_SocketError arg1)

Description: Signal declaration for QAbstractSocket::error(QAbstractSocket::SocketError)

You can bind a procedure to this signal.

bool flush

Description: Method bool QAbstractSocket::flush()

[event] void hostFound

Description: Signal declaration for QAbstractSocket::hostFound()

You can bind a procedure to this signal.

[const] bool isSequential?

Description: Method bool QAbstractSocket::isSequential()

This is a reimplementation of QIODevice::isSequential

[const] bool isValid?

Description: Method bool QAbstractSocket::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

[const] QHostAddress localAddress

Description: Method QHostAddress QAbstractSocket::localAddress()

[const] unsigned short localPort

Description: Method quint16 QAbstractSocket::localPort()

[static] new QAbstractSocket new(const QAbstractSocket_SocketType socketType,QObject ptr parent)

Description: Constructor QAbstractSocket::QAbstractSocket(QAbstractSocket::SocketType socketType, QObject *parent)

This method creates an object of class QAbstractSocket.

Python specific notes:

This method is the default initializer of the object

[const] QHostAddress peerAddress

Description: Method QHostAddress QAbstractSocket::peerAddress()

[const] string peerName

Description: Method QString QAbstractSocket::peerName()

[const] unsigned short peerPort

Description: Method quint16 QAbstractSocket::peerPort()

[const] QNetworkProxy proxy

Description: Method QNetworkProxy QAbstractSocket::proxy()

Python specific notes:

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

void proxy=(const QNetworkProxy networkProxy)

Description: Method void QAbstractSocket::setProxy(const QNetworkProxy &networkProxy)

Python specific notes:

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

[event] void proxyAuthenticationRequired(const QNetworkProxy proxy,QAuthenticator ptr authenticator)

Description: Signal declaration for QAbstractSocket::proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator)

You can bind a procedure to this signal.

[const] long long readBufferSize

Description: Method qint64 QAbstractSocket::readBufferSize()

Python specific notes:

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

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

void readBufferSize=(long long size)

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

Python specific notes:

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

[event] void readChannelFinished

Description: Signal declaration for QAbstractSocket::readChannelFinished()

You can bind a procedure to this signal.

[event] void readyRead

Description: Signal declaration for QAbstractSocket::readyRead()

You can bind a procedure to this signal.

void setProxy(const QNetworkProxy networkProxy)

Description: Method void QAbstractSocket::setProxy(const QNetworkProxy &networkProxy)

Python specific notes:

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

void setReadBufferSize(long long size)

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

Python specific notes:

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

bool setSocketDescriptor(int socketDescriptor,const QAbstractSocket_SocketState state = QAbstractSocket::ConnectedState,const QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method bool QAbstractSocket::setSocketDescriptor(int socketDescriptor, QAbstractSocket::SocketState state, QFlags<QIODevice::OpenModeFlag> openMode)

void setSocketOption(const QAbstractSocket_SocketOption option,const QVariant value)

Description: Method void QAbstractSocket::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

[const] int socketDescriptor

Description: Method int QAbstractSocket::socketDescriptor()

QVariant socketOption(const QAbstractSocket_SocketOption option)

Description: Method QVariant QAbstractSocket::socketOption(QAbstractSocket::SocketOption option)

[const] QAbstractSocket_SocketType socketType

Description: Method QAbstractSocket::SocketType QAbstractSocket::socketType()

[const] QAbstractSocket_SocketState state

Description: Method QAbstractSocket::SocketState QAbstractSocket::state()

[event] void stateChanged(const QAbstractSocket_SocketState arg1)

Description: Signal declaration for QAbstractSocket::stateChanged(QAbstractSocket::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 QAbstractSocket::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 QAbstractSocket::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 QAbstractSocket::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 QAbstractSocket::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 QAbstractSocket::waitForBytesWritten(int msecs)

This is a reimplementation of QIODevice::waitForBytesWritten

bool waitForConnected(int msecs = 30000)

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

bool waitForDisconnected(int msecs = 30000)

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

bool waitForReadyRead(int msecs = 30000)

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

This is a reimplementation of QIODevice::waitForReadyRead