libs/iostreams/doc/functions/combine.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML>
   3 <HEAD>
   4     <TITLE>Function Template combine</TITLE>
   5     <LINK REL="stylesheet" HREF="../../../../boost.css">
   6     <LINK REL="stylesheet" HREF="../theme/iostreams.css">
   7 </HEAD>
   8 <BODY>
   9
  10 <!-- Begin Banner -->
  11
  12     <H1 CLASS="title">Function Template <CODE>combine</CODE></H1>
  13     <HR CLASS="banner">
  14
  15 <!-- End Banner -->
  16
  17 <DL class="page-index">
  18   <DT><A href="#description">Description</A></DT>
  19   <DT><A href="#headers">Headers</A></DT>
  20   <DT><A href="#synopsis">Synopsis</A></DT>
  21 </DL>
  22
  23 <A NAME="description"></A>
  24 <H2>Description</H2>
  25
  26 <P>
  27     The class template <CODE>combination</CODE> takes an <A HREF="../concepts/input_filter.html">InputFilter</A>/<A HREF="../concepts/output_filter.html">OutputFilter</A> pair or a <A HREF="../concepts/source.html">Source</A>/<A HREF="../concepts/sink.html">Sink</A> pair and yields a Filter or Device which performs input using the first component and output using the second. The function template <CODE>combine</CODE> takes an <A HREF="../concepts/input_filter.html">InputFilter</A>/<A HREF="../concepts/output_filter.html">OutputFilter</A> pair or a <A HREF="../concepts/source.html">Source</A>/<A HREF="../concepts/sink.html">Sink</A> pair and returns an appropriate specialization of <CODE>combination</CODE>.
  28 </P>
  29
  30 <A NAME="headers"></A>
  31 <H2>Headers</H2>
  32
  33 <DL>
  34   <DT><A CLASS="header" HREF="../../../../boost/iostreams/combine.hpp"><CODE>&lt;boost/iostreams/combine.hpp&gt;</CODE></A></DT>
  35 </DL>
  36
  37 <A NAME="synopsis"></A>
  38 <H2>Synopsis</H2>
  39
  40 <PRE CLASS="broken_ie"><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
  41
  42 <SPAN CLASS="keyword">template</SPAN>&lt;<SPAN CLASS="keyword">typename</SPAN> In, <SPAN CLASS="keyword">typename</SPAN> Out&gt;
  43 <SPAN CLASS="keyword">class</SPAN> combination;
  44
  45 <SPAN CLASS="keyword">template</SPAN>&lt;<SPAN CLASS="keyword">typename</SPAN> In, <SPAN CLASS="keyword">typename</SPAN> Out&gt;
  46 combination&lt;In, Out&gt; combine(<SPAN CLASS="keyword">const</SPAN> In&amp; in, <SPAN CLASS="keyword">const</SPAN> Out&amp; out);
  47
  48 } } <SPAN CLASS="comment">// End namespace boost::io</SPAN></PRE>
  49
  50 <!-- Begin Footer -->
  51
  52 <HR>
  53
  54 <P CLASS="copyright">&copy; Copyright 2008 <a href="http://www.coderage.com/" target="_top">CodeRage, LLC</a><br/>&copy; Copyright 2004-2007 <a href="http://www.coderage.com/turkanis/" target="_top">Jonathan Turkanis</a></P>
  55 <P CLASS="copyright">
  56     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>)
  57 </P>
  58
  59 <!-- End Footer -->
  60
  61 </BODY>