---

lat::IOStatus Class Reference

Collection of file status information. More...

#include <Iguana/Utilities/classlib/iobase/IOStatus.h>

List of all members.

Public Types
enum	{ FlagUniqueValid = 1 }
enum	Type {   TypeUnknown, TypeFile, TypeDirectory, TypeSocket,   TypeSymlink, TypeNetworkSpecial, TypeBlockDev, TypeCharDev,   TypeFIFO, TypeVolumeId, TypeMessageQueue, TypeSemaphore,   TypeSharedMem, TypeMemoryObject }
	File types. More...
Public Member Functions
void	clear (void)
bool	fill (const char *name, bool traverseLinks=true)
bool	fill (IOFD fd)
Public Attributes
FileAcl	m_acl
Time	m_atime
Time	m_ctime
unsigned	m_flags
unsigned	m_links
Time	m_mtime
IOOffset	m_size
Type	m_type
unsigned	m_unique [3]

---

Detailed Description

Collection of file status information.

Using this information has limited value because of two reasons: not all systems provide meaningful values for all the fields, and many of the fields are not accurate.

Deductions from the file's owner and the access mode bits should be avoided: they do not work on ACL-based filesystems neither on UNIX nor on Windows. Instead use the more targeted queries such as Filename::isWritable() or File::times(). These usually return correct results.

Getting this information is not efficient on all systems. This is another reason to avoid this class unless the application knows what it is doing (e.g. choosing to be unportable for performance reasons).

Definition at line 40 of file IOStatus.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

FlagUniqueValid

Definition at line 63 of file IOStatus.h.

         {
        FlagUniqueValid = 1             //< #m_unique is valid.
    };

enum lat::IOStatus::Type

File types.

Enumerator:

TypeUnknown
TypeFile
TypeDirectory
TypeSocket
TypeSymlink
TypeNetworkSpecial
TypeBlockDev
TypeCharDev
TypeFIFO
TypeVolumeId
TypeMessageQueue
TypeSemaphore
TypeSharedMem
TypeMemoryObject

Definition at line 45 of file IOStatus.h.

    {
        TypeUnknown,            //< Unknown or unsupported.
        TypeFile,               //< Regular file.
        TypeDirectory,          //< Directory.
        TypeSocket,             //< Socket.
        TypeSymlink,            //< Symbolic link.
        TypeNetworkSpecial,     //< Network special file.
        TypeBlockDev,           //< Block device.
        TypeCharDev,            //< Character device.
        TypeFIFO,               //< FIFO (named or anonymous pipe).
        TypeVolumeId,           //< Volume label.
        TypeMessageQueue,       //< Message queue as a file type.
        TypeSemaphore,          //< Semaphore as a file type.
        TypeSharedMem,          //< Shared memory as a file type.
        TypeMemoryObject        //< Typed memory object as a file type.
    };

---

Member Function Documentation

void lat::IOStatus::clear

(

void

)

bool lat::IOStatus::fill	(	const char *	name,
		bool	traverseLinks = true
	)

bool lat::IOStatus::fill

(

IOFD

fd

)

---

Member Data Documentation

FileAcl lat::IOStatus::m_acl

Definition at line 72 of file IOStatus.h.

Time lat::IOStatus::m_atime

Definition at line 69 of file IOStatus.h.

Time lat::IOStatus::m_ctime

Definition at line 67 of file IOStatus.h.

unsigned lat::IOStatus::m_flags

Definition at line 74 of file IOStatus.h.

unsigned lat::IOStatus::m_links

Definition at line 77 of file IOStatus.h.

Time lat::IOStatus::m_mtime

Definition at line 68 of file IOStatus.h.

IOOffset lat::IOStatus::m_size

Definition at line 78 of file IOStatus.h.

Type lat::IOStatus::m_type

Definition at line 71 of file IOStatus.h.

unsigned lat::IOStatus::m_unique[3]

Definition at line 75 of file IOStatus.h.

---

The documentation for this class was generated from the following file:

• Iguana/Utilities/classlib/iobase/IOStatus.h

---