C++ Client API Reference for Oracle Coherence: coherence/io/WrapperStreamFactory.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_WRAPPER_STREAM_FACTORY_HPP
00008 #define COH_WRAPPER_STREAM_FACTORY_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/ReadBuffer.hpp"
00013 #include "coherence/io/WriteBuffer.hpp"
00014 
00015 COH_OPEN_NAMESPACE2(coherence,io)
00016 
00017 
00018 /**
00019 * Provides the means to wrap an BufferInput and BufferOutput, such that
00020 * functionality such as compression and encryption can be implemented
00021 * in a layered, pluggable fashion.
00022 *
00023 * @author nsa  2008.04.07
00024 */
00025 class COH_EXPORT WrapperStreamFactory
00026     : public interface_spec<WrapperStreamFactory>
00027     {
00028     // ----- WrapperStreamFactory interface ---------------------------------
00029 
00030     public:
00031         /**
00032         * Requests an InputStream that wraps the passed InputStream.
00033         *
00034         * @param  hIn  the coherence::io::ReadBuffer::BufferInput to be
00035         *              wrapped
00036         *
00037         * @return a BufferInput that delegates to ("wraps") the passed
00038         *         BufferInput
00039         */
00040         virtual ReadBuffer::BufferInput::Handle getInputStream(
00041                 ReadBuffer::BufferInput::Handle hIn) const = 0;
00042 
00043         /**
00044         * Requests an OutputStream that wraps the passed OutputStream.
00045         *
00046         * @param  hOut  the coherence::io::WriteBuffer::BufferOutput to be
00047         *               wrapped
00048         *
00049         * @return a BufferOutput that delegates to ("wraps") the passed
00050         *         BufferOutput
00051         */
00052         virtual WriteBuffer::BufferOutput::Handle getOutputStream(
00053                 WriteBuffer::BufferOutput::Handle hOut) const = 0;
00054     };
00055 
00056 COH_CLOSE_NAMESPACE2
00057 
00058 #endif // COH_WRAPPER_STREAM_FACTORY_HPP