Limit the maximum number of bytes transferred. More...

#include <cc/TransferLimiter>

Inheritance diagram for TransferLimiter:

Public Member Functions
	TransferLimiter ()=default
	Create an undefined transfer limiter.

	TransferLimiter (const Stream &stream, long long readLimit, long long writeLimit=-1)
	Create a new transfer limiter.

long long	readLimit () const
	Get the read transfer limit.

long long	writeLimit () const
	Get the write transfer limit.

long long	totalRead () const
	Get the total number of bytes read.

long long	totalWritten () const
	Get the total number of bytes written.

void	reset ()
	Reset the transfer counter to zero.

Public Member Functions inherited from Stream
	Stream ()=default
	Create a null stream.

bool	waitEstablished (int timeout=-1)
	Wait until the connection is fully established.

bool	wait (IoEvent event, int timeout=-1)
	Wait for an I/O event.

long	read (Out< Bytes > buffer, long maxFill=-1)
	Read available bytes into buffer and return number of bytes read.

void	write (const Bytes &buffer, long fill=-1)
	Write fill bytes from buffer (if fill < 0 write all bytes from buffer)

void	write (const List< Bytes > &buffers)
	Write the contents of buffers in one go.

void	write (const List< String > &parts)
	Convenience method, equivalent to 'write(parts.join())'.

void	write (const struct iovec *iov, int iovcnt)
	Write the contents of the iov buffers in one go.

void	write (const char *s)
	Write C-string s.

bool	isDiscarding () const
	Return true if this stream is discarding all writes

long long	transferTo (const Stream &sink, long long count, const Bytes &buffer)
	Transfer a span of bytes.

long long	transferTo (const Stream &sink, long long count=-1)
	Transfer a span of bytes.

long	defaultTransferUnit () const
	Default I/O buffer size.

long long	skip (long long count)
	Read and discard count bytes.

void	drain (const Bytes &auxBuffer=Bytes{})
	Read everything that is left.

long	readSpan (Out< Bytes > buffer)
	Read fixed number of bytes.

String	readSpan (long count)
	Read a fixed number of bytes.

String	readAll ()
	Read the entire stream.

Public Member Functions inherited from Object
	Object ()=default
	Create a null object.

	operator bool () const
	Check if this is a non-null object.

bool	isNull () const
	Check if this is a null object.

template<class T >
bool	is () const
	Check if this object is of type T.

template<class T >
T	as () const
	Cast this object to type T.

bool	isWeak () const
	Check if the underlying object reference is weak.

bool	operator== (const Object &other) const
	Equality operator.

std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.

long	useCount () const
	Reference count.

Additional Inherited Members
Protected Member Functions inherited from Stream
	Stream (State *newState)

State &	me ()

const State &	me () const

Protected Member Functions inherited from Object
template<class T >
T	weak () const

template<class T >
void	initOnce ()
	Create the object state when called the first time.

template<class T >
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.

	Object (State *newState)
	Initialize object with newState.

	Object (State *state, Alias)

	Object (State *state, Weak)

Object &	operator= (std::nullptr_t)

Static Protected Member Functions inherited from Object
template<class T >
static T	alias (const State *state)
	Create an alias object for the given state.

template<class T >
static T	weak (const State *state)

Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Limit the maximum number of bytes transferred.

Exceptions

InputExhaustion	Read limit exceeded
OutputExhaustion	Write limit exceeded

Constructor & Destructor Documentation

◆ TransferLimiter() [1/2]

TransferLimiter ( )

default

Create an undefined transfer limiter.

◆ TransferLimiter() [2/2]

TransferLimiter	(	const Stream &	stream,
		long long	readLimit,
		long long	writeLimit = -1 )

explicit

Create a new transfer limiter.

Member Function Documentation

◆ readLimit()

long long readLimit ( ) const

Get the read transfer limit.

◆ writeLimit()

long long writeLimit ( ) const

Get the write transfer limit.

◆ totalRead()

long long totalRead ( ) const

Get the total number of bytes read.

◆ totalWritten()

long long totalWritten ( ) const

Get the total number of bytes written.

◆ reset()

void reset ( )

Reset the transfer counter to zero.

Public Member Functions

Additional Inherited Members