CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
IoStream Class Reference

Base class for all system I/O streams. More...

#include <cc/IoStream>

Inheritance diagram for IoStream:

Public Member Functions

 IoStream ()=default
 Create a null I/O stream.
 
 IoStream (int fd)
 Create an I/O stream for file descriptor fd.
 
int fd () const
 File descriptor
 
void close ()
 Manually close this I/O stream.
 
void shutdown (IoShutdown mode=IoShutdown::Full)
 Manually shutdown this I/O stream.
 
void duplicateTo (IoStream &other)
 Duplicate this I/O stream.
 
IoStream duplicate () const
 Duplicate I/O stream other.
 
bool isInteractive () const
 Check if this is a teletype (e.g.
 
void echo (bool on)
 Set echo mode of this I/O stream to on
 
int ioctl (int request, void *arg)
 Issue an device control request.
 
long scatterLimit () const
 I/O scatter limit (in bytes)
 
void setScatterLimit (long newLimit)
 Set the I/O scatter limit (in bytes)
 
- 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 >
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.
 

Static Public Member Functions

static IoStreaminput ()
 Standard input stream.
 
static IoStreamoutput ()
 Standard output stream.
 
static IoStreamerror ()
 Standard error stream.
 
static void pair (Out< IoStream > a, Out< IoStream > b)
 Establish a full-duplex communication channel between a and b.
 

Protected Member Functions

 IoStream (State *newState)
 
State & me ()
 
const State & me () const
 
- Protected Member Functions inherited from Stream
 Stream (State *newState)
 
Stateme ()
 
const Stateme () const
 
- Protected Member Functions inherited from Object
template<class 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)
 
Objectoperator= (std::nullptr_t)
 

Additional Inherited Members

- 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< Stateme
 Internal object state
 

Detailed Description

Base class for all system I/O streams.

Constructor & Destructor Documentation

◆ IoStream() [1/2]

IoStream ( )
default

Create a null I/O stream.

◆ IoStream() [2/2]

IoStream ( int fd)
explicit

Create an I/O stream for file descriptor fd.

Member Function Documentation

◆ input()

IoStream & input ( )
static

Standard input stream.

◆ output()

IoStream & output ( )
static

Standard output stream.

◆ error()

IoStream & error ( )
static

Standard error stream.

◆ pair()

void pair ( Out< IoStream > a,
Out< IoStream > b )
static

Establish a full-duplex communication channel between a and b.

◆ fd()

int fd ( ) const

File descriptor

◆ close()

void close ( )

Manually close this I/O stream.

◆ shutdown()

void shutdown ( IoShutdown mode = IoShutdown::Full)

Manually shutdown this I/O stream.

Parameters
modeShutdown mode

◆ duplicateTo()

void duplicateTo ( IoStream & other)

Duplicate this I/O stream.

Parameters
otherThe other I/O stream to take over

The duplicate() method duplicates an entry in the file descriptor table.

This for instance allows to set a file as standard input:

File{"binary.dat"}.duplicateTo(stdIn());
File I/O streams
Definition File:22
void duplicateTo(IoStream &other)
Duplicate this I/O stream.
Definition IoStream.cc:181
See also
duplicate()

◆ duplicate()

IoStream duplicate ( ) const

Duplicate I/O stream other.

◆ isInteractive()

bool isInteractive ( ) const

Check if this is a teletype (e.g.

a pseudo-terminal)

◆ echo()

void echo ( bool on)

Set echo mode of this I/O stream to on

◆ ioctl()

int ioctl ( int request,
void * arg )

Issue an device control request.

Parameters
requestDevice control request
argRequest argument
Returns
Value returned by the request or 0

◆ scatterLimit()

long scatterLimit ( ) const

I/O scatter limit (in bytes)

◆ setScatterLimit()

void setScatterLimit ( long newLimit)

Set the I/O scatter limit (in bytes)