---

ACE_Handle_Gobbler Class Reference

This class gobbles up handles. More...

#include <Handle_Gobbler.h>

Collaboration diagram for ACE_Handle_Gobbler:

[legend]List of all members.

Public Methods
	~ACE_Handle_Gobbler (void)
	Destructor. Cleans up any remaining handles. More...
int	consume_handles (size_t n_handles_to_keep_available)
int	free_handles (size_t n_handles)
	Free up <n_handles>. More...
void	close_remaining_handles (void)
	All remaining handles are closed. More...
Private Types
typedef ACE_Unbounded_Set< ACE_HANDLE >	HANDLE_SET
Private Attributes
HANDLE_SET	handle_set_
	The container which holds the open descriptors. More...

---

Detailed Description

This class gobbles up handles.

This is useful when we need to control the number of handles available for a process. This class is mostly used for testing purposes.

Definition at line 35 of file Handle_Gobbler.h.

---

Member Typedef Documentation

typedef ACE_Unbounded_Set<ACE_HANDLE> ACE_Handle_Gobbler::HANDLE_SET [private]

Definition at line 57 of file Handle_Gobbler.h.

---

Constructor & Destructor Documentation

ACE_Handle_Gobbler::~ACE_Handle_Gobbler (  void    )  [inline]

Destructor. Cleans up any remaining handles. Definition at line 25 of file Handle_Gobbler.i. References close_remaining_handles. { this->close_remaining_handles (); }

---

Member Function Documentation

void ACE_Handle_Gobbler::close_remaining_handles (  void    )  [inline]

All remaining handles are closed. Definition at line 8 of file Handle_Gobbler.i. References ACE_Unbounded_Set< ACE_HANDLE >::begin, ACE_OS::close, ACE_Unbounded_Set< ACE_HANDLE >::end, and handle_set_. Referenced by ~ACE_Handle_Gobbler. { HANDLE_SET::iterator iterator = this->handle_set_.begin (); HANDLE_SET::iterator end = this->handle_set_.end (); for (; iterator != end; ++iterator) { ACE_OS::close (*iterator); } }

int ACE_Handle_Gobbler::consume_handles (  size_t    n_handles_to_keep_available )  [inline]

Handles are opened continously until the process runs out of them, and then <n_handles_to_keep_available> handles are closed (freed) thereby making them usable in the future. Definition at line 52 of file Handle_Gobbler.i. References ACE_DEV_NULL, free_handles, handle_set_, ACE_Unbounded_Set< ACE_HANDLE >::insert, ACE_OS::open, and ACE::out_of_handles. { int result = 0; #if defined(ACE_WIN32) // On Win32, this style of gobbling doesn't seem to work. ACE_UNUSED_ARG(n_handles_to_keep_available); #else while (1) { ACE_HANDLE handle = ACE_OS::open (ACE_DEV_NULL, O_WRONLY); if (handle == ACE_INVALID_HANDLE) { if (ACE::out_of_handles (errno)) { result = this->free_handles (n_handles_to_keep_available); break; } else { result = -1; break; } } result = this->handle_set_.insert (handle); if (result == -1) break; } #endif /* ACE_WIN32 */ return result; }

int ACE_Handle_Gobbler::free_handles (  size_t    n_handles )  [inline]

Free up <n_handles>. Definition at line 31 of file Handle_Gobbler.i. References ACE_Unbounded_Set< ACE_HANDLE >::begin, ACE_OS::close, ACE_Unbounded_Set< ACE_HANDLE >::end, and handle_set_. Referenced by consume_handles. { HANDLE_SET::iterator iterator = this->handle_set_.begin (); HANDLE_SET::iterator end = this->handle_set_.end (); for (; iterator != end && n_handles > 0; ++iterator, --n_handles) { int result = ACE_OS::close (*iterator); if (result != 0) return result; } return 0; }

---

Member Data Documentation

HANDLE_SET ACE_Handle_Gobbler::handle_set_ [private]

The container which holds the open descriptors. Definition at line 60 of file Handle_Gobbler.h. Referenced by close_remaining_handles, consume_handles, and free_handles.

---

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

• Handle_Gobbler.h
• Handle_Gobbler.i

---