Cpl::Io::Socket::StreamPool< N > Class Template Reference

This concrete template class implement a socket factory that is capable of creating N concurrently opened socket streams. More...

Detailed Description

template<int N>
class Cpl::Io::Socket::StreamPool< N >

This concrete template class implement a socket factory that is capable of creating N concurrently opened socket streams.

#include <StreamPool.h>

Inheritance diagram for Cpl::Io::Socket::StreamPool< N >:

Collaboration diagram for Cpl::Io::Socket::StreamPool< N >:

Public Member Functions
	StreamPool (bool fatalErrors=true)
	Constructor. When 'fatalErrors' is true, out-of-memory conditions will be FatalErrors.
Cpl::Io::Socket::InputOutput *	create ()
	See Cpl::Io::Socket::Factory.
void	destory (Cpl::Io::Socket::InputOutput &socketStream)
	See Cpl::Io::Socket::Factory.
Public Member Functions inherited from Cpl::Io::Socket::Factory
virtual	~Factory ()
	Virtual destructor.
Public Member Functions inherited from Cpl::Memory::SPool< Cpl::Io::Socket::InputOutput, N >
	SPool (bool fatalErrors=false)
	Constructor.
void *	allocate (size_t numbytes)
	See Cpl::Memory::Allocator.
void	release (void *ptr)
	See Cpl::Memory::Allocator.
size_t	wordSize () const noexcept
	See Cpl::Memory::Allocator.
Public Member Functions inherited from Cpl::Memory::Allocator
size_t	allocatedSizeForNBytes (size_t nbytes) const noexcept
	Convenience method that determines the actual amount of memory that actually allocated for a successful allocate request of N bytes.
virtual	~Allocator ()
	Provide a virtual destructor.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Attributes inherited from Cpl::Memory::SPool< Cpl::Io::Socket::InputOutput, N >
AlignedClass< Cpl::Io::Socket::InputOutput >	m_blocks [N]
	Allocate blocks.
Pool_::BlockInfo_	m_infoBlocks [N]
	Allocate memory for BlockInfo_ instances.
Pool_	m_pool
	My Pool work object.

Constructor & Destructor Documentation

StreamPool()

template<int N>

Cpl::Io::Socket::StreamPool< N >::StreamPool

(

bool

fatalErrors = true

)

Constructor. When 'fatalErrors' is true, out-of-memory conditions will be FatalErrors.

Member Function Documentation

create()

template<int N>

Cpl::Io::Socket::InputOutput * Cpl::Io::Socket::StreamPool< N >::create ( )

virtual

See Cpl::Io::Socket::Factory.

Implements Cpl::Io::Socket::Factory.

destory()

template<int N>

void Cpl::Io::Socket::StreamPool< N >::destory ( Cpl::Io::Socket::InputOutput &  socketStream )

virtual

See Cpl::Io::Socket::Factory.

Implements Cpl::Io::Socket::Factory.

---

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

• Cpl/Io/Socket/StreamPool.h