Files
iostreams/doc/functions/combine.html
Jonathan Turkanis 9b39e2a437 major documentation upgrade, phase II
[SVN r29504]
2005-06-10 04:03:05 +00:00

69 lines
2.9 KiB
HTML
Executable File

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Function Template combine</TITLE>
<LINK REL="stylesheet" HREF="../../../../boost.css">
<LINK REL="stylesheet" HREF="../theme/iostreams.css">
</HEAD>
<BODY>
<!-- Begin Banner -->
<H1 CLASS="title">Function Template <CODE>combine</CODE></H1>
<HR CLASS="banner">
<!-- End Banner -->
<DL class="page-index">
<DT><A href="#description">Description</A></DT>
<DT><A href="#headers">Headers</A></DT>
<DT><A href="#synopsis">Synopsis</A></DT>
</DL>
<A NAME="description">
<H2>Description</H2>
<P>
The class template <CODE>combination</CODE> is an adapter which produces a model of <A HREF="../concepts/bidirectional_device.html">BidirectionalDevice</A> from a model of <A HREF="../concepts/source.html">Source</A> and a model of <A HREF="../concepts/sink.html">Sink</A> pair or from a model of <A HREF="../concepts/input_filter.html">InputFilter</A> and a model of <A HREF="../concepts/output_filter.html">OutputFilter</A>. An instance of <CODE>combination</CODE> is constructed from a pair of instances of its template paratemers; it performs input using the first component and output using the second.
</P>
<P>
The function template <CODE>combine</CODE> takes a <A HREF="../concepts/source.html">Source</A>/<A HREF="../concepts/sink.html">Sink</A> pair or an <A HREF="../concepts/input_filter.html">InputFilter</A>/<A HREF="../concepts/output_filter.html">OutputFilter</A> pair and returns an appropriate specialization of <CODE>combination</CODE>.
</P>
<A NAME="headers">
<H2>Headers</H2>
<DL>
<DT><A CLASS="header" HREF="../../../../boost/iostreams/combine.hpp"><CODE>&lt;boost/iostreams/combine.hpp&gt;</CODE></A></DT>
</DL>
<A NAME="synopsis">
<H2>Synopsis</H2>
<PRE CLASS="broken_ie"><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
<SPAN CLASS="keyword">template</SPAN>&lt;<SPAN CLASS="keyword">typename</SPAN> In, <SPAN CLASS="keyword">typename</SPAN> Out&gt;
<SPAN CLASS="keyword">class</SPAN> combination;
<SPAN CLASS="keyword">template</SPAN>&lt;<SPAN CLASS="keyword">typename</SPAN> In, <SPAN CLASS="keyword">typename</SPAN> Out&gt;
combination&lt;In, Out&gt; combine(<SPAN CLASS="keyword">const</SPAN> In& in, <SPAN CLASS="keyword">const</SPAN> Out& out);
} } <SPAN CLASS="comment">// End namespace boost::io</SPAN></PRE>
<!-- Begin Footer -->
<HR>
<P CLASS="copyright">Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
20 May, 2004
<!--webbot bot="Timestamp" endspan i-checksum="38504" -->
</P>
<P CLASS="copyright">&copy; Copyright Jonathan Turkanis, 2004</P>
<P CLASS="copyright">
Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <A HREF="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</A>)
</P>
<!-- End Footer -->
</BODY>