API reference - Class QLocalServer

Notation used in Ruby API documentation

Description: Binding of QLocalServer

Class hierarchy: QLocalServer » QObject

Public constructors

new QLocalServernew(QObject ptr parent = 0)Constructor QLocalServer::QLocalServer(QObject *parent)

Public methods

voidcloseMethod void QLocalServer::close()
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QLocalServer::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]stringerrorStringMethod QString QLocalServer::errorString()
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QLocalServer::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QLocalServer::eventFilter(QObject *, QEvent *)
[const]stringfullServerNameMethod QString QLocalServer::fullServerName()
[virtual,const]boolhasPendingConnectionsVirtual method bool QLocalServer::hasPendingConnections()
[const]boolisListeningMethod bool QLocalServer::isListening()
[const]boolisListening?Method bool QLocalServer::isListening()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
boollisten(string name)Method bool QLocalServer::listen(const QString &name)
[const]intmaxPendingConnectionsMethod int QLocalServer::maxPendingConnections()
voidmaxPendingConnections=(int numConnections)Method void QLocalServer::setMaxPendingConnections(int numConnections)
[event]voidnewConnectionSignal declaration for QLocalServer::newConnection()
[virtual]QLocalSocket ptrnextPendingConnectionVirtual method QLocalSocket *QLocalServer::nextPendingConnection()
[const]QAbstractSocket_SocketErrorserverErrorMethod QAbstractSocket::SocketError QLocalServer::serverError()
[const]stringserverNameMethod QString QLocalServer::serverName()
voidsetMaxPendingConnections(int numConnections)Method void QLocalServer::setMaxPendingConnections(int numConnections)
boolwaitForNewConnection(int msec = 0,
bool ptr timedOut = 0)
Method bool QLocalServer::waitForNewConnection(int msec, bool *timedOut)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

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

Detailed description

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void close

Description: Method void QLocalServer::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 QLocalServer::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 QLocalServer::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 QLocalServer::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[const] string errorString

Description: Method QString QLocalServer::errorString()

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[const] string fullServerName

Description: Method QString QLocalServer::fullServerName()

[virtual,const] bool hasPendingConnections

Description: Virtual method bool QLocalServer::hasPendingConnections()

This method can be reimplemented in a derived class.

[virtual] void incomingConnection(unsigned int socketDescriptor)

Description: Virtual method void QLocalServer::incomingConnection(quintptr socketDescriptor)

This method can be reimplemented in a derived class.

[const] bool isListening

Description: Method bool QLocalServer::isListening()

[const] bool isListening?

Description: Method bool QLocalServer::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(string name)

Description: Method bool QLocalServer::listen(const QString &name)

[const] int maxPendingConnections

Description: Method int QLocalServer::maxPendingConnections()

void maxPendingConnections=(int numConnections)

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

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

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

This method creates an object of class QLocalServer.

[event] void newConnection

Description: Signal declaration for QLocalServer::newConnection()

You can bind a procedure to this signal.

[virtual] QLocalSocket ptr nextPendingConnection

Description: Virtual method QLocalSocket *QLocalServer::nextPendingConnection()

This method can be reimplemented in a derived class.

[const] int receivers(string signal)

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

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

[static] bool removeServer(string name)

Description: Static method bool QLocalServer::removeServer(const QString &name)

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

[const] QObject ptr sender

Description: Method QObject *QLocalServer::sender()

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

[const] QAbstractSocket_SocketError serverError

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

[const] string serverName

Description: Method QString QLocalServer::serverName()

void setMaxPendingConnections(int numConnections)

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

Description: Static method QString QLocalServer::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 QLocalServer::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 QLocalServer::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 QLocalServer::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 QLocalServer::waitForNewConnection(int msec, bool *timedOut)