API reference - Class QTcpServer

Notation used in Ruby API documentation

Description: Binding of QTcpServer

Class hierarchy: QTcpServer » QObject

Public constructors

new QTcpServernew(QObject ptr parent = 0)Constructor QTcpServer::QTcpServer(QObject *parent)

Public methods

voidcloseMethod void QTcpServer::close()
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QTcpServer::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]stringerrorStringMethod QString QTcpServer::errorString()
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QTcpServer::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QTcpServer::eventFilter(QObject *, QEvent *)
[virtual,const]boolhasPendingConnectionsVirtual method bool QTcpServer::hasPendingConnections()
[const]boolisListeningMethod bool QTcpServer::isListening()
[const]boolisListening?Method bool QTcpServer::isListening()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
boollisten(const QHostAddress address = QHostAddress::Any,
unsigned short port = 0)
Method bool QTcpServer::listen(const QHostAddress &address, quint16 port)
[const]intmaxPendingConnectionsMethod int QTcpServer::maxPendingConnections()
voidmaxPendingConnections=(int numConnections)Method void QTcpServer::setMaxPendingConnections(int numConnections)
[event]voidnewConnectionSignal declaration for QTcpServer::newConnection()
[virtual]QTcpSocket ptrnextPendingConnectionVirtual method QTcpSocket *QTcpServer::nextPendingConnection()
[const]QNetworkProxyproxyMethod QNetworkProxy QTcpServer::proxy()
voidproxy=(const QNetworkProxy networkProxy)Method void QTcpServer::setProxy(const QNetworkProxy &networkProxy)
[const]QHostAddressserverAddressMethod QHostAddress QTcpServer::serverAddress()
[const]QAbstractSocket_SocketErrorserverErrorMethod QAbstractSocket::SocketError QTcpServer::serverError()
[const]unsigned shortserverPortMethod quint16 QTcpServer::serverPort()
voidsetMaxPendingConnections(int numConnections)Method void QTcpServer::setMaxPendingConnections(int numConnections)
voidsetProxy(const QNetworkProxy networkProxy)Method void QTcpServer::setProxy(const QNetworkProxy &networkProxy)
boolsetSocketDescriptor(int socketDescriptor)Method bool QTcpServer::setSocketDescriptor(int socketDescriptor)
[const]intsocketDescriptorMethod int QTcpServer::socketDescriptor()
boolsocketDescriptor=(int socketDescriptor)Method bool QTcpServer::setSocketDescriptor(int socketDescriptor)
boolwaitForNewConnection(int msec = 0,
bool ptr timedOut = 0)
Method bool QTcpServer::waitForNewConnection(int msec, bool *timedOut)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QTcpServer::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QTcpServer::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QTcpServer::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QTcpServer::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QTcpServer::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QTcpServer::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QTcpServer::disconnectNotify(const char *signal)
[virtual]voidincomingConnection(int handle)Virtual method void QTcpServer::incomingConnection(int handle)
[const]intreceivers(string signal)Method int QTcpServer::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QTcpServer::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QTcpServer::timerEvent(QTimerEvent *)

Detailed description

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QTcpServer::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

void close

Description: Method void QTcpServer::close()

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.

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QTcpServer::customEvent(QEvent *)

This method can be reimplemented in a derived class.

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.

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

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

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QTcpServer::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[const] string errorString

Description: Method QString QTcpServer::errorString()

[virtual] bool event(QEvent ptr arg1)

Description: Virtual method bool QTcpServer::event(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QTcpServer::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[virtual,const] bool hasPendingConnections

Description: Virtual method bool QTcpServer::hasPendingConnections()

This method can be reimplemented in a derived class.

[virtual] void incomingConnection(int handle)

Description: Virtual method void QTcpServer::incomingConnection(int handle)

This method can be reimplemented in a derived class.

[const] bool isListening

Description: Method bool QTcpServer::isListening()

[const] bool isListening?

Description: Method bool QTcpServer::isListening()

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

bool listen(const QHostAddress address = QHostAddress::Any,unsigned short port = 0)

Description: Method bool QTcpServer::listen(const QHostAddress &address, quint16 port)

[const] int maxPendingConnections

Description: Method int QTcpServer::maxPendingConnections()

void maxPendingConnections=(int numConnections)

Description: Method void QTcpServer::setMaxPendingConnections(int numConnections)

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

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

This method creates an object of class QTcpServer.

[event] void newConnection

Description: Signal declaration for QTcpServer::newConnection()

You can bind a procedure to this signal.

[virtual] QTcpSocket ptr nextPendingConnection

Description: Virtual method QTcpSocket *QTcpServer::nextPendingConnection()

This method can be reimplemented in a derived class.

[const] QNetworkProxy proxy

Description: Method QNetworkProxy QTcpServer::proxy()

void proxy=(const QNetworkProxy networkProxy)

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

[const] int receivers(string signal)

Description: Method int QTcpServer::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

[const] QObject ptr sender

Description: Method QObject *QTcpServer::sender()

This method is protected and can only be called from inside a derived class.

[const] QHostAddress serverAddress

Description: Method QHostAddress QTcpServer::serverAddress()

[const] QAbstractSocket_SocketError serverError

Description: Method QAbstractSocket::SocketError QTcpServer::serverError()

[const] unsigned short serverPort

Description: Method quint16 QTcpServer::serverPort()

void setMaxPendingConnections(int numConnections)

Description: Method void QTcpServer::setMaxPendingConnections(int numConnections)

void setProxy(const QNetworkProxy networkProxy)

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

bool setSocketDescriptor(int socketDescriptor)

Description: Method bool QTcpServer::setSocketDescriptor(int socketDescriptor)

[const] int socketDescriptor

Description: Method int QTcpServer::socketDescriptor()

bool socketDescriptor=(int socketDescriptor)

Description: Method bool QTcpServer::setSocketDescriptor(int socketDescriptor)

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QTcpServer::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

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

Description: Static method QString QTcpServer::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 QTcpServer::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 QTcpServer::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 QTcpServer::trUtf8(const char *s, const char *c, int n)

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

bool waitForNewConnection(int msec = 0,bool ptr timedOut = 0)

Description: Method bool QTcpServer::waitForNewConnection(int msec, bool *timedOut)