API reference - Class QAbstractSocket

AddressInUseError

Signature: [static,const] QAbstractSocket_SocketError AddressInUseError

Description: Enum constant QAbstractSocket::AddressInUseError

Python specific notes:
The object exposes a readable attribute 'AddressInUseError'. This is the getter.

BoundState

Signature: [static,const] QAbstractSocket_SocketState BoundState

Description: Enum constant QAbstractSocket::BoundState

Python specific notes:
The object exposes a readable attribute 'BoundState'. This is the getter.

ClosingState

Signature: [static,const] QAbstractSocket_SocketState ClosingState

Description: Enum constant QAbstractSocket::ClosingState

Python specific notes:
The object exposes a readable attribute 'ClosingState'. This is the getter.

ConnectedState

Signature: [static,const] QAbstractSocket_SocketState ConnectedState

Description: Enum constant QAbstractSocket::ConnectedState

Python specific notes:
The object exposes a readable attribute 'ConnectedState'. This is the getter.

ConnectingState

Signature: [static,const] QAbstractSocket_SocketState ConnectingState

Description: Enum constant QAbstractSocket::ConnectingState

Python specific notes:
The object exposes a readable attribute 'ConnectingState'. This is the getter.

ConnectionRefusedError

Signature: [static,const] QAbstractSocket_SocketError ConnectionRefusedError

Description: Enum constant QAbstractSocket::ConnectionRefusedError

Python specific notes:
The object exposes a readable attribute 'ConnectionRefusedError'. This is the getter.

DatagramTooLargeError

Signature: [static,const] QAbstractSocket_SocketError DatagramTooLargeError

Description: Enum constant QAbstractSocket::DatagramTooLargeError

Python specific notes:
The object exposes a readable attribute 'DatagramTooLargeError'. This is the getter.

HostLookupState

Signature: [static,const] QAbstractSocket_SocketState HostLookupState

Description: Enum constant QAbstractSocket::HostLookupState

Python specific notes:
The object exposes a readable attribute 'HostLookupState'. This is the getter.

HostNotFoundError

Signature: [static,const] QAbstractSocket_SocketError HostNotFoundError

Description: Enum constant QAbstractSocket::HostNotFoundError

Python specific notes:
The object exposes a readable attribute 'HostNotFoundError'. This is the getter.

IPv4Protocol

Signature: [static,const] QAbstractSocket_NetworkLayerProtocol IPv4Protocol

Description: Enum constant QAbstractSocket::IPv4Protocol

Python specific notes:
The object exposes a readable attribute 'IPv4Protocol'. This is the getter.

IPv6Protocol

Signature: [static,const] QAbstractSocket_NetworkLayerProtocol IPv6Protocol

Description: Enum constant QAbstractSocket::IPv6Protocol

Python specific notes:
The object exposes a readable attribute 'IPv6Protocol'. This is the getter.

KeepAliveOption

Signature: [static,const] QAbstractSocket_SocketOption KeepAliveOption

Description: Enum constant QAbstractSocket::KeepAliveOption

Python specific notes:
The object exposes a readable attribute 'KeepAliveOption'. This is the getter.

ListeningState

Signature: [static,const] QAbstractSocket_SocketState ListeningState

Description: Enum constant QAbstractSocket::ListeningState

Python specific notes:
The object exposes a readable attribute 'ListeningState'. This is the getter.

LowDelayOption

Signature: [static,const] QAbstractSocket_SocketOption LowDelayOption

Description: Enum constant QAbstractSocket::LowDelayOption

Python specific notes:
The object exposes a readable attribute 'LowDelayOption'. This is the getter.

NetworkError

Signature: [static,const] QAbstractSocket_SocketError NetworkError

Description: Enum constant QAbstractSocket::NetworkError

Python specific notes:
The object exposes a readable attribute 'NetworkError'. This is the getter.

ProxyAuthenticationRequiredError

Signature: [static,const] QAbstractSocket_SocketError ProxyAuthenticationRequiredError

Description: Enum constant QAbstractSocket::ProxyAuthenticationRequiredError

Python specific notes:
The object exposes a readable attribute 'ProxyAuthenticationRequiredError'. This is the getter.

ProxyConnectionClosedError

Signature: [static,const] QAbstractSocket_SocketError ProxyConnectionClosedError

Description: Enum constant QAbstractSocket::ProxyConnectionClosedError

Python specific notes:
The object exposes a readable attribute 'ProxyConnectionClosedError'. This is the getter.

ProxyConnectionRefusedError

Signature: [static,const] QAbstractSocket_SocketError ProxyConnectionRefusedError

Description: Enum constant QAbstractSocket::ProxyConnectionRefusedError

Python specific notes:
The object exposes a readable attribute 'ProxyConnectionRefusedError'. This is the getter.

ProxyConnectionTimeoutError

Signature: [static,const] QAbstractSocket_SocketError ProxyConnectionTimeoutError

Description: Enum constant QAbstractSocket::ProxyConnectionTimeoutError

Python specific notes:
The object exposes a readable attribute 'ProxyConnectionTimeoutError'. This is the getter.

ProxyNotFoundError

Signature: [static,const] QAbstractSocket_SocketError ProxyNotFoundError

Description: Enum constant QAbstractSocket::ProxyNotFoundError

Python specific notes:
The object exposes a readable attribute 'ProxyNotFoundError'. This is the getter.

ProxyProtocolError

Signature: [static,const] QAbstractSocket_SocketError ProxyProtocolError

Description: Enum constant QAbstractSocket::ProxyProtocolError

Python specific notes:
The object exposes a readable attribute 'ProxyProtocolError'. This is the getter.

RemoteHostClosedError

Signature: [static,const] QAbstractSocket_SocketError RemoteHostClosedError

Description: Enum constant QAbstractSocket::RemoteHostClosedError

Python specific notes:
The object exposes a readable attribute 'RemoteHostClosedError'. This is the getter.

SocketAccessError

Signature: [static,const] QAbstractSocket_SocketError SocketAccessError

Description: Enum constant QAbstractSocket::SocketAccessError

Python specific notes:
The object exposes a readable attribute 'SocketAccessError'. This is the getter.

SocketAddressNotAvailableError

Signature: [static,const] QAbstractSocket_SocketError SocketAddressNotAvailableError

Description: Enum constant QAbstractSocket::SocketAddressNotAvailableError

Python specific notes:
The object exposes a readable attribute 'SocketAddressNotAvailableError'. This is the getter.

SocketResourceError

Signature: [static,const] QAbstractSocket_SocketError SocketResourceError

Description: Enum constant QAbstractSocket::SocketResourceError

Python specific notes:
The object exposes a readable attribute 'SocketResourceError'. This is the getter.

SocketTimeoutError

Signature: [static,const] QAbstractSocket_SocketError SocketTimeoutError

Description: Enum constant QAbstractSocket::SocketTimeoutError

Python specific notes:
The object exposes a readable attribute 'SocketTimeoutError'. This is the getter.

SslHandshakeFailedError

Signature: [static,const] QAbstractSocket_SocketError SslHandshakeFailedError

Description: Enum constant QAbstractSocket::SslHandshakeFailedError

Python specific notes:
The object exposes a readable attribute 'SslHandshakeFailedError'. This is the getter.

TcpSocket

Signature: [static,const] QAbstractSocket_SocketType TcpSocket

Description: Enum constant QAbstractSocket::TcpSocket

Python specific notes:
The object exposes a readable attribute 'TcpSocket'. This is the getter.

UdpSocket

Signature: [static,const] QAbstractSocket_SocketType UdpSocket

Description: Enum constant QAbstractSocket::UdpSocket

Python specific notes:
The object exposes a readable attribute 'UdpSocket'. This is the getter.

UnconnectedState

Signature: [static,const] QAbstractSocket_SocketState UnconnectedState

Description: Enum constant QAbstractSocket::UnconnectedState

Python specific notes:
The object exposes a readable attribute 'UnconnectedState'. This is the getter.

UnfinishedSocketOperationError

Signature: [static,const] QAbstractSocket_SocketError UnfinishedSocketOperationError

Description: Enum constant QAbstractSocket::UnfinishedSocketOperationError

Python specific notes:
The object exposes a readable attribute 'UnfinishedSocketOperationError'. This is the getter.

UnknownNetworkLayerProtocol

Signature: [static,const] QAbstractSocket_NetworkLayerProtocol UnknownNetworkLayerProtocol

Description: Enum constant QAbstractSocket::UnknownNetworkLayerProtocol

Python specific notes:
The object exposes a readable attribute 'UnknownNetworkLayerProtocol'. This is the getter.

UnknownSocketError

Signature: [static,const] QAbstractSocket_SocketError UnknownSocketError

Description: Enum constant QAbstractSocket::UnknownSocketError

Python specific notes:
The object exposes a readable attribute 'UnknownSocketError'. This is the getter.

UnknownSocketType

Signature: [static,const] QAbstractSocket_SocketType UnknownSocketType

Description: Enum constant QAbstractSocket::UnknownSocketType

Python specific notes:
The object exposes a readable attribute 'UnknownSocketType'. This is the getter.

UnsupportedSocketOperationError

Signature: [static,const] QAbstractSocket_SocketError UnsupportedSocketOperationError

Description: Enum constant QAbstractSocket::UnsupportedSocketOperationError

Python specific notes:
The object exposes a readable attribute 'UnsupportedSocketOperationError'. This is the getter.

_const_cast

Signature: [const] QAbstractSocket ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: 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.

_destroy

Signature: 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.

_destroyed?

Signature: [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.

_is_const_object?

Signature: [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.

_manage

Signature: 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.

_unmanage

Signature: 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.

abort

Signature: void abort

Description: Method void QAbstractSocket::abort()

aboutToClose

Signature: [signal] void aboutToClose

Description: Signal declaration for QAbstractSocket::aboutToClose()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'aboutToClose'. This is the getter.
The object exposes a writable attribute 'aboutToClose'. This is the setter.

atEnd

Signature: [const] bool atEnd

Description: Method bool QAbstractSocket::atEnd()

This is a reimplementation of QIODevice::atEnd

bytesAvailable

Signature: [const] long long bytesAvailable

Description: Method qint64 QAbstractSocket::bytesAvailable()

This is a reimplementation of QIODevice::bytesAvailable

bytesToWrite

Signature: [const] long long bytesToWrite

Description: Method qint64 QAbstractSocket::bytesToWrite()

This is a reimplementation of QIODevice::bytesToWrite

bytesWritten

Signature: [signal] void bytesWritten (long long bytes)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'bytesWritten'. This is the getter.
The object exposes a writable attribute 'bytesWritten'. This is the setter.

canReadLine

Signature: [const] bool canReadLine

Description: Method bool QAbstractSocket::canReadLine()

This is a reimplementation of QIODevice::canReadLine

close

Signature: void close

Description: Method void QAbstractSocket::close()

This is a reimplementation of QIODevice::close

connectToHost

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

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

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

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

connected

Signature: [signal] void connected

Description: Signal declaration for QAbstractSocket::connected()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'connected'. This is the getter.
The object exposes a writable attribute 'connected'. This is the setter.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectFromHost

Signature: void disconnectFromHost

Description: Method void QAbstractSocket::disconnectFromHost()

disconnected

Signature: [signal] void disconnected

Description: Signal declaration for QAbstractSocket::disconnected()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'disconnected'. This is the getter.
The object exposes a writable attribute 'disconnected'. This is the setter.

error

Signature: [const] QAbstractSocket_SocketError error

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

error_sig

Signature: [signal] void error_sig (const QAbstractSocket_SocketError arg1)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'error_sig'. This is the getter.
The object exposes a writable attribute 'error_sig'. This is the setter.

flush

Signature: bool flush

Description: Method bool QAbstractSocket::flush()

hostFound

Signature: [signal] void hostFound

Description: Signal declaration for QAbstractSocket::hostFound()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'hostFound'. This is the getter.
The object exposes a writable attribute 'hostFound'. This is the setter.

isSequential?

Signature: [const] bool isSequential?

Description: Method bool QAbstractSocket::isSequential()

This is a reimplementation of QIODevice::isSequential

isValid?

Signature: [const] bool isValid?

Description: Method bool QAbstractSocket::isValid()

localAddress

Signature: [const] QHostAddress localAddress

Description: Method QHostAddress QAbstractSocket::localAddress()

localPort

Signature: [const] unsigned short localPort

Description: Method quint16 QAbstractSocket::localPort()

new

Signature: [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.

peerAddress

Signature: [const] QHostAddress peerAddress

Description: Method QHostAddress QAbstractSocket::peerAddress()

peerName

Signature: [const] string peerName

Description: Method QString QAbstractSocket::peerName()

peerPort

Signature: [const] unsigned short peerPort

Description: Method quint16 QAbstractSocket::peerPort()

proxy

Signature: [const] QNetworkProxy proxy

Description: Method QNetworkProxy QAbstractSocket::proxy()

Python specific notes:
The object exposes a readable attribute 'proxy'. This is the getter.

proxy=

Signature: 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.

proxyAuthenticationRequired

Signature: [signal] 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.

Python specific notes:
The object exposes a readable attribute 'proxyAuthenticationRequired'. This is the getter.
The object exposes a writable attribute 'proxyAuthenticationRequired'. This is the setter.

readBufferSize

Signature: [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.

readBufferSize=

Signature: 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.

readChannelFinished

Signature: [signal] void readChannelFinished

Description: Signal declaration for QAbstractSocket::readChannelFinished()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'readChannelFinished'. This is the getter.
The object exposes a writable attribute 'readChannelFinished'. This is the setter.

readyRead

Signature: [signal] void readyRead

Description: Signal declaration for QAbstractSocket::readyRead()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'readyRead'. This is the getter.
The object exposes a writable attribute 'readyRead'. This is the setter.

setProxy

Signature: 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.

setReadBufferSize

Signature: 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.

setSocketDescriptor

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

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

setSocketOption

Signature: void setSocketOption (const QAbstractSocket_SocketOption option, variant value)

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

socketDescriptor

Signature: [const] int socketDescriptor

Description: Method int QAbstractSocket::socketDescriptor()

socketOption

Signature: variant socketOption (const QAbstractSocket_SocketOption option)

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

socketType

Signature: [const] QAbstractSocket_SocketType socketType

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

state

Signature: [const] QAbstractSocket_SocketState state

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

stateChanged

Signature: [signal] void stateChanged (const QAbstractSocket_SocketState arg1)

Description: Signal declaration for QAbstractSocket::stateChanged(QAbstractSocket::SocketState)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'stateChanged'. This is the getter.
The object exposes a writable attribute 'stateChanged'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tr

(1) Signature: [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.

(2) Signature: [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.

trUtf8

(1) Signature: [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.

(2) Signature: [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.

waitForBytesWritten

Signature: bool waitForBytesWritten (int msecs = 30000)

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

This is a reimplementation of QIODevice::waitForBytesWritten

waitForConnected

Signature: bool waitForConnected (int msecs = 30000)

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

waitForDisconnected

Signature: bool waitForDisconnected (int msecs = 30000)

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

waitForReadyRead

Signature: bool waitForReadyRead (int msecs = 30000)

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

This is a reimplementation of QIODevice::waitForReadyRead