Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template basic_pipe

boost::process::basic_pipe

Synopsis

// In header: <boost/process/pipe.hpp>

template<typename CharT, typename Traits> 
class basic_pipe {
public:
  // types
  typedef             ;    
  typedef            ;  
  typedef  ;     
  typedef  ;     
  typedef  ;     
  typedef       ;

  // construct/copy/destruct
  ();
  ();
  (basic_pipe &);
  (basic_pipe &&);
  basic_pipe & (basic_pipe &);
  basic_pipe & (basic_pipe &&);
  ~();

  // public member functions
   () ;
   () ;
   ();
   ();
   (, );
   (, );
   ();
   ();
};

Description

Class implementation of a pipe.

basic_pipe public construct/copy/destruct

  1. ();
    Default construct the pipe. Will be opened.
  2. ( name);
    Construct a named pipe.
  3. (basic_pipe & p);

    Copy construct the pipe.

    [Note] Note

    Duplicated the handles.

  4. (basic_pipe && lhs);

    Move construct the pipe.

  5. basic_pipe & (basic_pipe & p);

    Copy assign the pipe.

    [Note] Note

    Duplicated the handles.

  6. basic_pipe & (basic_pipe && lhs);

    Move assign the pipe.

  7. ~();

    Destructor closes the handles.

basic_pipe public member functions

  1.  () ;

    Get the native handle of the source.

  2.  () ;

    Get the native handle of the sink.

  3.  ( h);

    Assign a new value to the source

  4.  ( h);

    Assign a new value to the sink

  5.  ( data,  count);
    Write data to the pipe.
  6.  ( data,  count);
    Read data from the pipe.
  7.  ();
    Check if the pipe is open.
  8.  ();
    Close the pipe.

PrevUpHomeNext