O Tools Library]

Collaboration diagram for I/O Buffers:

Classes

class CAsyncFileReader

A class that implements IHandler to provide an asynchronous file reader that uses overlapped I/O to perform reads from the file. Data read from the file is provided in a 'push fashion' via the CAsyncFileReader::Callback interface. More...

class CAsyncFileReader::Callback

An interface for users of the CAsyncFileReader to be notified of the results of the asynchronous read operations on the file. More...

class CAsyncFileWriter

A class that implements IHandler to provide an asynchronous file writer that uses overlapped I/O to perform writes to the file. Any errors that occur during the asynchronous file writes are reported via the CAsyncFileWriter::Callback interface. More...

class CAsyncFileWriterEx

A class that implements IHandler to provide an asynchronous file writer that uses overlapped I/O to perform writes to the file. Any errors that occur during the asynchronous file writes are reported via the CAsyncFileWriter::Callback interface. More...

class CBuffer

An implementation of the IBuffer interface which includes its own custom new and delete functionality so that the memory for the buffer and the memory for the rest of the class are allocated as a single block of memory. Note that the 'user data' is also allocated as part of the main buffer memory and the class knows how to access the various memory areas correctly. Note that the buffers may be allocated using VirtualAlloc() to align the memory on page boundaries; in this case, it's best to create buffers with a size that is a multiple of the system's page size less the size of the buffer object, see CBufferAllocator for more details. More...

class CBufferAllocator

An implementation of IAllocateBuffers which pools buffer instances for later reuse. More...

class CBufferBasedBufferAllocator

class CBufferChain

class CBufferHandle

An implementation of IBuffer that provides a separate WSABUF for another implementation of IBuffer. This is used to broadcast the contents of an IBuffer to multiple receivers without needing to copy the data in the buffer. Each receiver has a CBufferHandle allocated which is attached to the IBuffer that contains the data that needs to be broadcast. When the final send completes the references held by the CBufferHandle objects on the IBuffer will fall to 0 and the buffer will be released. More...

class CBufferHandleAllocator

An implementation of IAllocateBufferHandles which pools buffer handle instances for later reuse. More...

class CBufferProcessor

class CBufferRingBuffer

class IAddBuffersToPool

class IAllocatableBuffer

class IAllocateBuffer

class IAllocateBufferHandles

An interface to a class that allocates instances of CBufferHandle which can be attached to an instance of an IBuffer. More...

class IAllocateBuffers

An interface to a class that allocates instances of IBuffer of a fixed size. Each instance of IBuffer has opaque user data associated with it and so this allocator derives from IProvideUserData to allow the user to request user data "slots" from the allocator; you must request all of your slots before calling Allocate() for the first time. More...

class IBufferBase

An interface to a I/O buffer (with a partially refactored name!). Initially IBuffer and IBufferBase was one class, it was split to make it easier to mock and in an attempt to remove some of the socket stuff. Classes that implement this interface represent a byte buffer that can be used for overlapped I/O and that consist of a contiguous array of bytes and an insertion point which moves along the buffer as data is added to it. More work needs to be done. More...

class IBufferChain

class IHandler

An interface that represents code that handles operations on I/O buffers. More...

class IIOPool

An interface to an I/O thread pool (usually based on an I/O completion port) that can have operations on buffers and handlers dispatched to it (either directly or as a result of an I/O completion packet being generated by some asynchronous I/O event) and that handles these events on one of the threads in the pool. More...

class IIterateableBufferChain

class IManageBufferHandleLifeCycle

A helper interface to remove a friend relationship between buffers and their allocators... More...

class IManageBufferLifeCycle

A helper interface to remove a friend relationship between buffers and their allocators... More...

class IMonitorBufferAllocation

An interface to allow a class to monitor the operation of a class that allocates buffers. The interface assumes that buffers go through the following life-cycle: created, allocated, released, destroyed. Allocators that pool buffers can allow a buffer to be created once and then allocated and released several times before being deleted. Incrementing a counter when OnBufferCreated() is called and decrementing it when OnBufferDestroyed() is called will give you a count of the number of buffers that are in existence at any one time. A corresponding counter that is incremented in OnBufferAllocated() and decremented when OnBufferReleased() is called will give a count of the buffers that are currently in use. More...

class IPoolBuffers

class IProvideWorkItems

A restricted interface onto a queue of work items (such as an I/O completion port, perhaps). More...

class IUnsortedBufferChain

class CNullBufferAllocationMonitor

An object that implements IMonitorBufferAllocation and does nothing. More...

class CNullBufferPool

class CSequencedBufferCollection

A class that manages a collection of IBuffer instances which have a unique and ascending sequence number in them. You are allowed to push buffers into the collection in any order and to retrieve them only in the correct sequence. If you try and retrieve a buffer when the required buffer is not present then the collection will return null. Typical usage is to ensure the correct ordering of multiple overlapped read completions. All buffers are pushed into the collection using GetNext() and a buffer is only returned to the caller for processing if it is the next in sequence. This class takes a reference on a buffer when it is added to the collection and requires that the user of a buffer that has been removed from the collection releases that reference when done. More...

class CSortedBufferChain

class CSortedBufferProcessor

The C++ framework for developing highly scalable, high performance servers on Windows platforms.

Search

I/O Buffers
[I/O Tools Library]

Classes


Classes
class	CAsyncFileReader
	A class that implements IHandler to provide an asynchronous file reader that uses overlapped I/O to perform reads from the file. Data read from the file is provided in a 'push fashion' via the CAsyncFileReader::Callback interface. More...
class	CAsyncFileReader::Callback
	An interface for users of the CAsyncFileReader to be notified of the results of the asynchronous read operations on the file. More...
class	CAsyncFileWriter
	A class that implements IHandler to provide an asynchronous file writer that uses overlapped I/O to perform writes to the file. Any errors that occur during the asynchronous file writes are reported via the CAsyncFileWriter::Callback interface. More...
class	CAsyncFileWriterEx
	A class that implements IHandler to provide an asynchronous file writer that uses overlapped I/O to perform writes to the file. Any errors that occur during the asynchronous file writes are reported via the CAsyncFileWriter::Callback interface. More...
class	CBuffer
	An implementation of the IBuffer interface which includes its own custom new and delete functionality so that the memory for the buffer and the memory for the rest of the class are allocated as a single block of memory. Note that the 'user data' is also allocated as part of the main buffer memory and the class knows how to access the various memory areas correctly. Note that the buffers may be allocated using VirtualAlloc() to align the memory on page boundaries; in this case, it's best to create buffers with a size that is a multiple of the system's page size less the size of the buffer object, see CBufferAllocator for more details. More...
class	CBufferAllocator
	An implementation of IAllocateBuffers which pools buffer instances for later reuse. More...
class	CBufferBasedBufferAllocator
class	CBufferChain
class	CBufferHandle
	An implementation of IBuffer that provides a separate WSABUF for another implementation of IBuffer. This is used to broadcast the contents of an IBuffer to multiple receivers without needing to copy the data in the buffer. Each receiver has a CBufferHandle allocated which is attached to the IBuffer that contains the data that needs to be broadcast. When the final send completes the references held by the CBufferHandle objects on the IBuffer will fall to 0 and the buffer will be released. More...
class	CBufferHandleAllocator
	An implementation of IAllocateBufferHandles which pools buffer handle instances for later reuse. More...
class	CBufferProcessor
class	CBufferRingBuffer
class	IAddBuffersToPool
class	IAllocatableBuffer
class	IAllocateBuffer
class	IAllocateBufferHandles
	An interface to a class that allocates instances of CBufferHandle which can be attached to an instance of an IBuffer. More...
class	IAllocateBuffers
	An interface to a class that allocates instances of IBuffer of a fixed size. Each instance of IBuffer has opaque user data associated with it and so this allocator derives from IProvideUserData to allow the user to request user data "slots" from the allocator; you must request all of your slots before calling Allocate() for the first time. More...
class	IBufferBase
	An interface to a I/O buffer (with a partially refactored name!). Initially IBuffer and IBufferBase was one class, it was split to make it easier to mock and in an attempt to remove some of the socket stuff. Classes that implement this interface represent a byte buffer that can be used for overlapped I/O and that consist of a contiguous array of bytes and an insertion point which moves along the buffer as data is added to it. More work needs to be done. More...
class	IBufferChain
class	IHandler
	An interface that represents code that handles operations on I/O buffers. More...
class	IIOPool
	An interface to an I/O thread pool (usually based on an I/O completion port) that can have operations on buffers and handlers dispatched to it (either directly or as a result of an I/O completion packet being generated by some asynchronous I/O event) and that handles these events on one of the threads in the pool. More...
class	IIterateableBufferChain
class	IManageBufferHandleLifeCycle
	A helper interface to remove a friend relationship between buffers and their allocators... More...
class	IManageBufferLifeCycle
	A helper interface to remove a friend relationship between buffers and their allocators... More...
class	IMonitorBufferAllocation
	An interface to allow a class to monitor the operation of a class that allocates buffers. The interface assumes that buffers go through the following life-cycle: created, allocated, released, destroyed. Allocators that pool buffers can allow a buffer to be created once and then allocated and released several times before being deleted. Incrementing a counter when OnBufferCreated() is called and decrementing it when OnBufferDestroyed() is called will give you a count of the number of buffers that are in existence at any one time. A corresponding counter that is incremented in OnBufferAllocated() and decremented when OnBufferReleased() is called will give a count of the buffers that are currently in use. More...
class	IPoolBuffers
class	IProvideWorkItems
	A restricted interface onto a queue of work items (such as an I/O completion port, perhaps). More...
class	IUnsortedBufferChain
class	CNullBufferAllocationMonitor
	An object that implements IMonitorBufferAllocation and does nothing. More...
class	CNullBufferPool
class	CSequencedBufferCollection
	A class that manages a collection of IBuffer instances which have a unique and ascending sequence number in them. You are allowed to push buffers into the collection in any order and to retrieve them only in the correct sequence. If you try and retrieve a buffer when the required buffer is not present then the collection will return null. Typical usage is to ensure the correct ordering of multiple overlapped read completions. All buffers are pushed into the collection using GetNext() and a buffer is only returned to the caller for processing if it is the next in sequence. This class takes a reference on a buffer when it is added to the collection and requires that the user of a buffer that has been removed from the collection releases that reference when done. More...
class	CSortedBufferChain
class	CSortedBufferProcessor

The C++ framework for developing highly scalable, high performance servers on Windows platforms.

Search

I/O Buffers [I/O Tools Library]

Classes

I/O Buffers
[I/O Tools Library]