scclib
Stable Cloud Computing C++ Library
Public Member Functions | List of all members
scc::util::OutStream Class Reference

Output stream wrapper for writer. More...

#include <iostream.h>

Inheritance diagram for scc::util::OutStream:
Inheritance graph
[legend]
Collaboration diagram for scc::util::OutStream:
Collaboration graph
[legend]

Public Member Functions

 OutStream (Writer &, size_t=1024)
 Create writer stream. More...
 
 OutStream (const std::shared_ptr< Writer > &, size_t=1024)
 Create writer stream. More...
 
 OutStream ()=delete
 No default construct.
 
 OutStream (const OutStream &)=delete
 Copy construct not allowed.
 
OutStreamoperator= (const OutStream &)=delete
 Copy assign not allowed.
 
 OutStream (OutStream &&)
 Move construct.
 
OutStreamoperator= (OutStream &&)
 Move assign.
 
void write_reset (const std::shared_ptr< Writer > &)
 
std::shared_ptr< Writerwrite_shared () const
 
size_t sendbuf_size () const
 Size of send buffer.
 
void sendbuf_size (size_t)
 Resize the send buffer. More...
 
virtual std::string send_fail () const
 Failure message from outstream. More...
 
void clear (std::ios::iostate=std::ios::goodbit)
 

Detailed Description

Output stream wrapper for writer.

Makes Writer objects compatible with std::ostream.

Examples
examples/net/netmain.cc, util/unittest/iohelper.cc, and util/unittest/iostream.cc.

Definition at line 107 of file iostream.h.

Constructor & Destructor Documentation

◆ OutStream() [1/2]

OutStream::OutStream ( Writer writer,
size_t  send_buf_sz = 1024 
)

Create writer stream.

Does not assume ownership of object. Useful for temporary use, otherwise use the shared pointer form.

Parameters
writerWriter.
send_buf_szSize of send buffer. Number of bytes to be buffered before writing to the underlying writer.

Definition at line 443 of file iostream.cc.

◆ OutStream() [2/2]

OutStream::OutStream ( const std::shared_ptr< Writer > &  writer,
size_t  send_buf_sz = 1024 
)

Create writer stream.

Parameters
writerWriter shared pointer.
send_buf_szSize of send buffer. Number of bytes to be buffered before writing to the underlying writer.

Definition at line 450 of file iostream.cc.

Member Function Documentation

◆ send_fail()

std::string OutStream::send_fail ( ) const
virtual

Failure message from outstream.

When an exception is thrown during an underlying write, the exception value is set in send_fail(), and the bad bit is set.

When a write returns 0, the eof bit is set.

Definition at line 519 of file iostream.cc.

◆ sendbuf_size()

void OutStream::sendbuf_size ( size_t  sz)

Resize the send buffer.

This will clear any data currently in the output buffer.

Definition at line 509 of file iostream.cc.


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