ACE_Dirent Class Reference

Define a portable C++ directory-entry iterator based on the POSIX API. More...

#include <Dirent.h>

List of all members.

Public Member Functions
	ACE_Dirent (void)
	Default constructor.
	ACE_Dirent (const ACE_TCHAR *dirname)
	Constructor calls <opendir>.
int	open (const ACE_TCHAR *filename)
	~ACE_Dirent (void)
	Destructor calls <closedir>.
void	close (void)
	Closes the directory stream and frees the <ACE_DIR> structure.
ACE_DIRENT *	read (void)
int	read (struct ACE_DIRENT *entry, struct ACE_DIRENT **result)
long	tell (void)
void	seek (long loc)
void	rewind (void)
Private Attributes
ACE_DIR *	dirp_
	Pointer to the directory stream.

---

Detailed Description

Define a portable C++ directory-entry iterator based on the POSIX API.

Definition at line 35 of file Dirent.h.

---

Constructor & Destructor Documentation

ACE_INLINE ACE_Dirent::ACE_Dirent

(

void

)

Default constructor.

Definition at line 30 of file Dirent.inl.

  : dirp_ (0)
{
}

ACE_INLINE ACE_Dirent::ACE_Dirent

(

const ACE_TCHAR *

dirname

)

[explicit]

Constructor calls <opendir>.

Definition at line 36 of file Dirent.inl.

References ACE_ERROR, ACE_TEXT, and LM_ERROR.

  : dirp_ (0)
{
  if (this->open (dirname) == -1)
    ACE_ERROR ((LM_ERROR,
                ACE_TEXT ("%p\n"),
                ACE_TEXT ("ACE_Dirent::ACE_Dirent")));
}

ACE_INLINE ACE_Dirent::~ACE_Dirent

(

void

)

Destructor calls <closedir>.

Definition at line 46 of file Dirent.inl.

References ACE_OS::closedir().

{
  if (this->dirp_ != 0)
    ACE_OS::closedir (this->dirp_);
}

---

Member Function Documentation

ACE_INLINE void ACE_Dirent::close

(

void

)

Closes the directory stream and frees the <ACE_DIR> structure.

Definition at line 68 of file Dirent.inl.

References ACE_OS::closedir(), and dirp_.

{
  if (this->dirp_ != 0)
    {
      ACE_OS::closedir (this->dirp_);

      // Prevent double closure
      this->dirp_ = 0;
    }
}

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE int ACE_Dirent::open

(

const ACE_TCHAR *

filename

)

Opens the directory named by filename and associates a directory stream with it.

Definition at line 10 of file Dirent.inl.

References ACE_OS::closedir(), dirp_, and ACE_OS::opendir().

{
  // If the directory stream is already open, close it to prevent
  // possible resource leaks.

  if (this->dirp_ != 0)
    {
      ACE_OS::closedir (this->dirp_);
      this->dirp_ = 0;
    }

  this->dirp_ = ACE_OS::opendir (dirname);

  if (this->dirp_ == 0)
    return -1;
  else
    return 0;
}

ACE_INLINE int ACE_Dirent::read	(	struct ACE_DIRENT *	entry,
		struct ACE_DIRENT **	result
	)

Has the equivalent functionality as <readdir> except that an entry and result buffer must be supplied by the caller to store the result.

Definition at line 59 of file Dirent.inl.

References dirp_, and ACE_OS::readdir_r().

{
  return this->dirp_
         ? ACE_OS::readdir_r (this->dirp_, entry, result)
         : 0;
}

ACE_INLINE ACE_DIRENT * ACE_Dirent::read

(

void

)

Returns a pointer to a structure representing the directory entry at the current position in the directory stream to which dirp refers, and positions the directory stream at the next entry, except on read-only filesystems. It returns a NULL pointer upon reaching the end of the directory stream, or upon detecting an invalid location in the directory. <readdir> shall not return directory entries containing empty names. It is unspecified whether entries are returned for dot or dot-dot. The pointer returned by <readdir> points to data that may be overwritten by another call to <readdir> on the same directory stream. This data shall not be overwritten by another call to <readdir> on a different directory stream. <readdir> may buffer several directory entries per actual read operation; <readdir> marks for update the st_atime field of the directory each time the directory is actually read.

Definition at line 53 of file Dirent.inl.

References dirp_, and ACE_OS::readdir().

{
  return this->dirp_ ? ACE_OS::readdir (this->dirp_) : 0;
}

ACE_INLINE void ACE_Dirent::rewind

(

void

)

Resets the position of the directory stream to the beginning of the directory. It also causes the directory stream to refer to the current state of the corresponding directory, as a call to <opendir> would.

Definition at line 80 of file Dirent.inl.

References ACE_OS::rewinddir().

{
  if (this->dirp_)
    ACE_OS::rewinddir (this->dirp_);
}

ACE_INLINE void ACE_Dirent::seek

(

long

loc

)

Sets the position of the next <readdir> operation on the directory stream. The new position reverts to the position associated with the directory stream at the time the <telldir> operation that provides loc was performed. Values returned by <telldir> are good only for the lifetime of the <ACE_DIR> pointer from which they are derived. If the directory is closed and then reopened, the <telldir> value may be invalidated due to undetected directory compaction. It is safe to use a previous <telldir> value immediately after a call to <opendir> and before any calls to readdir.

Definition at line 87 of file Dirent.inl.

References ACE_OS::seekdir().

{
  if (this->dirp_)
    ACE_OS::seekdir (this->dirp_, loc);
}

ACE_INLINE long ACE_Dirent::tell

(

void

)

Returns the current location associated with the directory stream.

Definition at line 94 of file Dirent.inl.

References dirp_, and ACE_OS::telldir().

{
  return this->dirp_ ? ACE_OS::telldir (this->dirp_) : 0;
}

---

Member Data Documentation

ACE_DIR* ACE_Dirent::dirp_ [private]

Pointer to the directory stream.

Definition at line 112 of file Dirent.h.

Referenced by close(), open(), read(), and tell().

---

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

• Dirent.h
• Dirent.inl

---