API reference - Class QLocalSocket_LocalSocketError

Notation used in Ruby API documentation

Description: This class represents the QLocalSocket::LocalSocketError enum

Class hierarchy: QLocalSocket_LocalSocketError » QLocalSocket_QFlags_LocalSocketError

Public constructors

new QLocalSocket_LocalSocketErrornew(unsigned int value)Creates the enum object from an integer

Public methods

[const]bool==(QLocalSocket_LocalSocketError other)Compares the enum class against an enum of it's own type
[const]bool==(unsigned int other)Compares the enum class against an integer
[const]voidassign(const QLocalSocket_LocalSocketError other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QLocalSocket_LocalSocketErrordupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]unsigned intto_iConverts the enum class to an integer
[const]stringto_sConverts the enum class to a string

Public static methods and constants

new QLocalSocket_LocalSocketErrorConnectionErrorEnum constant QLocalSocket::ConnectionError
new QLocalSocket_LocalSocketErrorConnectionRefusedErrorEnum constant QLocalSocket::ConnectionRefusedError
new QLocalSocket_LocalSocketErrorDatagramTooLargeErrorEnum constant QLocalSocket::DatagramTooLargeError
new QLocalSocket_LocalSocketErrorPeerClosedErrorEnum constant QLocalSocket::PeerClosedError
new QLocalSocket_LocalSocketErrorServerNotFoundErrorEnum constant QLocalSocket::ServerNotFoundError
new QLocalSocket_LocalSocketErrorSocketAccessErrorEnum constant QLocalSocket::SocketAccessError
new QLocalSocket_LocalSocketErrorSocketResourceErrorEnum constant QLocalSocket::SocketResourceError
new QLocalSocket_LocalSocketErrorSocketTimeoutErrorEnum constant QLocalSocket::SocketTimeoutError
new QLocalSocket_LocalSocketErrorUnknownSocketErrorEnum constant QLocalSocket::UnknownSocketError
new QLocalSocket_LocalSocketErrorUnsupportedSocketOperationErrorEnum constant QLocalSocket::UnsupportedSocketOperationError

Detailed description

[const] bool ==(QLocalSocket_LocalSocketError other)

Description: Compares the enum class against an enum of it's own type

[const] bool ==(unsigned int other)

Description: Compares the enum class against an integer

[static] new QLocalSocket_LocalSocketError ConnectionError

Description: Enum constant QLocalSocket::ConnectionError

[static] new QLocalSocket_LocalSocketError ConnectionRefusedError

Description: Enum constant QLocalSocket::ConnectionRefusedError

[static] new QLocalSocket_LocalSocketError DatagramTooLargeError

Description: Enum constant QLocalSocket::DatagramTooLargeError

[static] new QLocalSocket_LocalSocketError PeerClosedError

Description: Enum constant QLocalSocket::PeerClosedError

[static] new QLocalSocket_LocalSocketError ServerNotFoundError

Description: Enum constant QLocalSocket::ServerNotFoundError

[static] new QLocalSocket_LocalSocketError SocketAccessError

Description: Enum constant QLocalSocket::SocketAccessError

[static] new QLocalSocket_LocalSocketError SocketResourceError

Description: Enum constant QLocalSocket::SocketResourceError

[static] new QLocalSocket_LocalSocketError SocketTimeoutError

Description: Enum constant QLocalSocket::SocketTimeoutError

[static] new QLocalSocket_LocalSocketError UnknownSocketError

Description: Enum constant QLocalSocket::UnknownSocketError

[static] new QLocalSocket_LocalSocketError UnsupportedSocketOperationError

Description: Enum constant QLocalSocket::UnsupportedSocketOperationError

[const] void assign(const QLocalSocket_LocalSocketError other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

[const] QLocalSocket_LocalSocketError dup

Description: Creates a copy of self

[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_LocalSocketError new(unsigned int value)

Description: Creates the enum object from an integer

[const] unsigned int to_i

Description: Converts the enum class to an integer

[const] string to_s

Description: Converts the enum class to a string