• Concurrency::streams::details::basic_streambuf< _CharType >
• Concurrency::streams::producer_consumer_buffer< _CharType >
• Concurrency::streams::rawptr_buffer< _CharType >

Constructor.

Parameters

ptr A pointer to the concrete stream buffer implementation.

Default constructor.

Converter Constructor.

Template Parameters

AlterCharType The data type of the basic element of the source streambuf.

Parameters

other The source buffer to be converted.

Destructor

Gets a pointer to the next already allocated contiguous block of data.

Parameters

ptr A reference to a pointer variable that will hold the address of the block on success.

count The number of contiguous characters available at the address in 'ptr.'

Returns

true if the operation succeeded, false otherwise.

A return of false does not necessarily indicate that a subsequent read operation would fail, only that there is no block to return immediately or that the stream buffer does not support the operation. The stream buffer may not de-allocate the block until ::release method is called. If the end of the stream is reached, the function will return true, a null pointer, and a count of zero; a subsequent read will not succeed.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Allocates a contiguous memory block and returns it.

Parameters

count The number of characters to allocate.

Returns

A pointer to a block to write to, null if the stream buffer implementation does not support alloc/commit.

Gets the stream buffer size, if one has been set.

Parameters

direction The direction of buffering (in or out)

Returns

The size of the internal buffer (for the given direction).

An implementation that does not support buffering will always return 0.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Reads a single character from the stream and advances the read position.

Returns

The value of the character. EOF if the read fails.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

can_read is used to determine whether a stream buffer will support read operations (get).

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

can_seek is used to determine whether a stream buffer supports seeking.

Returns

True if seeking is supported, false otherwise.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

can_write is used to determine whether a stream buffer will support write operations (put).

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Closes the stream buffer, preventing further read or write operations.

Parameters

mode The I/O mode (in or out) to close for.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Closes the stream buffer with an exception.

Parameters

mode The I/O mode (in or out) to close for.

eptr Pointer to the exception.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Submits a block already allocated by the stream buffer.

Parameters

count The number of characters to be committed.

Constructs an input stream head for this stream buffer.

Returns

basic_istream .

Constructs an output stream for this stream buffer.

Returns

basic_ostream

Retrieves the stream buffer exception_ptr if it has been set.

Returns

Pointer to the exception, if it has been set; otherwise, nullptr will be returned

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Reads a single character from the stream without advancing the read position.

Returns

The value of the byte. EOF if the read fails.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Reads up to a given number of characters from the stream.

Parameters

ptr The address of the target memory area.

count The maximum number of characters to read.

Returns

The number of characters read. O if the end of the stream is reached.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Gets the current read or write position in the stream.

Parameters

direction The I/O direction to seek (see remarks)

Returns

The current position. EOF if the operation fails.

Some streams may have separate write and read cursors. For such streams, the direction parameter defines whether to move the read or the write cursor.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

has_size is used to determine whether a stream buffer supports size().

Returns

True if the size API is supported, false otherwise.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

For any input stream, in_avail returns the number of characters that are immediately available to be consumed without blocking. May be used in conjunction with <cref="::sbumpc method"/> to read data without incurring the overhead of using tasks.

Returns

Number of characters that are ready to read.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

is_eof is used to determine whether a read head has reached the end of the buffer.

Returns

True if at the end of the buffer, false otherwise.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Checks if the stream buffer is open.

No separation is made between open for reading and open for writing.

Returns

True if the stream buffer is open for reading or writing, false otherwise.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Advances the read position, then returns the next character without advancing again.

Returns

The value of the character. EOF if the read fails.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Checks if the stream buffer has been initialized or not.

Writes a single character to the stream.

Parameters

ch The character to write

Returns

The value of the character. EOF if the write operation fails

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Writes a number of characters to the stream.

Parameters

ptr A pointer to the block of data to be written.

count The number of characters to write.

Returns

The number of characters actually written, either 'count' or 0.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Writes a number of characters to the stream. Note: callers must make sure the data to be written is valid until the returned task completes.

Parameters

ptr A pointer to the block of data to be written.

count The number of characters to write.

Returns

The number of characters actually written, either 'count' or 0.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Releases a block of data acquired using ::acquire method. This frees the stream buffer to de-allocate the memory, if it so desires. Move the read position ahead by the count.

Parameters

ptr A pointer to the block of data to be released.

count The number of characters that were read.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Reads a single character from the stream and advances the read position.

Returns

The value of the character. -1 if the read fails. -2 if an asynchronous read is required

This is a synchronous operation, but is guaranteed to never block.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Copies up to a given number of characters from the stream, synchronously.

Parameters

ptr The address of the target memory area.

count The maximum number of characters to read.

Returns

The number of characters copied. O if the end of the stream is reached or an asynchronous read is required.

This is a synchronous operation, but is guaranteed to never block.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Seeks to a position given by a relative offset.

Parameters

offset The relative position to seek to

way The starting point (beginning, end, current) for the seek.

mode The I/O direction to seek (see remarks)

Returns

The position. EOF if the operation fails.

Some streams may have separate write and read cursors. For such streams, the mode parameter defines whether to move the read or the write cursor.

Seeks to the given position.

Parameters

pos The offset from the beginning of the stream.

direction The I/O direction to seek (see remarks).

Returns

The position. EOF if the operation fails.

Some streams may have separate write and read cursors. For such streams, the direction parameter defines whether to move the read or the write cursor.

Sets the stream buffer implementation to buffer or not buffer.

Parameters

size The size to use for internal buffering, 0 if no buffering should be done.

direction The direction of buffering (in or out)

An implementation that does not support buffering will silently ignore calls to this function and it will not have any effect on what is returned by subsequent calls to ::buffer_size method.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Reads a single character from the stream without advancing the read position.

Returns

The value of the character. EOF if the read fails. ::requires_async method if an asynchronous read is required

This is a synchronous operation, but is guaranteed to never block.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Gets the total number of characters in the stream buffer, if known. Calls to has_size will determine whether the result of size can be relied on.

Returns

The total number of characters in the stream buffer.

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

For output streams, flush any internally buffered data to the underlying medium.

Returns

true if the flush succeeds, false if not

Implements Concurrency::streams::details::basic_streambuf< _CharType >.

Retreats the read position, then returns the current character without advancing.

Returns

The value of the character. EOF if the read fails. ::requires_async method if an asynchronous read is required

Implements Concurrency::streams::details::basic_streambuf< _CharType >.