QDBusUnixFileDescriptor Class Reference

Member Function Documentation

QDBusUnixFileDescriptor::QDBusUnixFileDescriptor ()

Constructs a QDBusUnixFileDescriptor without a wrapped file descriptor. This is equivalent to constructing the object with an invalid file descriptor (like -1).

See also fileDescriptor() and isValid().

QDBusUnixFileDescriptor::QDBusUnixFileDescriptor ( int fileDescriptor )

Constructs a QDBusUnixFileDescriptor object by copying the fileDescriptor parameter. The original file descriptor is not touched and must be closed by the user.

Note that the value returned by fileDescriptor() will be different from the fileDescriptor parameter passed.

If the fileDescriptor parameter is not valid, isValid() will return false and fileDescriptor() will return -1.

See also setFileDescriptor() and fileDescriptor().

QDBusUnixFileDescriptor::QDBusUnixFileDescriptor ( const QDBusUnixFileDescriptor & other )

Constructs a QDBusUnixFileDescriptor object by copying other.

QDBusUnixFileDescriptor::~QDBusUnixFileDescriptor ()

Destroys this QDBusUnixFileDescriptor object and disposes of the Unix file descriptor that it contained.

int QDBusUnixFileDescriptor::fileDescriptor () const

Returns the Unix file descriptor contained by this QDBusUnixFileDescriptor object. An invalid file descriptor is represented by the value -1.

Note that the file descriptor returned by this function is owned by the QDBusUnixFileDescriptor object and must not be stored past the lifetime of this object. It is ok to use it while this object is valid, but if one wants to store it for longer use, the file descriptor should be cloned using the Unix dup(2), dup2(2) or dup3(2) functions.

See also setFileDescriptor() and isValid().

bool QDBusUnixFileDescriptor::isSupported () [static]

Returns true if Unix file descriptors are supported on this platform. In other words, this function returns true if this is a Unix platform.

Note that QDBusUnixFileDescriptor continues to operate even if this function returns false. The only difference is that the QDBusUnixFileDescriptor objects will always be in the isValid() == false state and fileDescriptor() will always return -1. The class will not consume any operating system resources.

bool QDBusUnixFileDescriptor::isValid () const

Returns true if this Unix file descriptor is valid. A valid Unix file descriptor is not -1.

See also fileDescriptor().

void QDBusUnixFileDescriptor::setFileDescriptor ( int fileDescriptor )

Sets the file descriptor that this QDBusUnixFileDescriptor object holds to a copy of fileDescriptor. The original file descriptor is not touched and must be closed by the user.

Note that the value returned by fileDescriptor() will be different from the fileDescriptor parameter passed.

If the fileDescriptor parameter is not valid, isValid() will return false and fileDescriptor() will return -1.

See also isValid() and fileDescriptor().

QDBusUnixFileDescriptor & QDBusUnixFileDescriptor::operator= ( const QDBusUnixFileDescriptor & other )

Copies the Unix file descriptor from the other QDBusUnixFileDescriptor object. If the current object contained a file descriptor, it will be properly disposed of before.