tests/framework/include/dpl/abstract_output.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /*
  17  * @file        abstract_output.h
  18  * @author      Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
  19  * @version     1.0
  20  * @brief       This file is the header file of abstract output
  21  */
  22 #ifndef DPL_ABSTRACT_OUTPUT_H
  23 #define DPL_ABSTRACT_OUTPUT_H
  24
  25 #include <dpl/exception.h>
  26 #include <memory>
  27
  28 namespace DPL {
  29 class BinaryQueue;
  30 typedef std::auto_ptr<BinaryQueue> BinaryQueueAutoPtr;
  31
  32 class AbstractOutput
  33 {
  34   public:
  35     class Exception
  36     {
  37       public:
  38         DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
  39         DECLARE_EXCEPTION_TYPE(Base, WriteFailed)
  40     };
  41
  42   public:
  43     virtual ~AbstractOutput() {}
  44
  45     /**
  46      * Write binary data to output
  47      * If output is blocked, Write returns zero, if instance is a type of
  48      * WaitableAbstractOutput one can wait for writability then
  49      *
  50      * @param[in] buffer Input buffer with data to be written
  51      * @param[in] bufferSize Maximum number of bytes to write from buffer
  52      * @return Number of bytes success successfuly written or zero if output is
  53      * blocked
  54      * @throw WriteFailed
  55      */
  56     virtual size_t Write(const BinaryQueue &buffer, size_t bufferSize) = 0;
  57 };
  58 } // namespace DPL
  59
  60 #endif // DPL_ABSTRACT_OUTPUT_H