2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @file abstract_input.h
18 * @author Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
20 * @brief This file is the header file of abstract input
22 #ifndef DPL_ABSTRACT_INPUT_H
23 #define DPL_ABSTRACT_INPUT_H
25 #include <dpl/exception.h>
30 typedef std::auto_ptr<BinaryQueue> BinaryQueueAutoPtr;
38 DECLARE_EXCEPTION_TYPE(DPL::Exception, Base)
39 DECLARE_EXCEPTION_TYPE(Base, ReadFailed)
43 virtual ~AbstractInput() {}
46 * Read binary data from input
47 * If no data is available method returns nullptr buffer.
48 * In case connection was successfuly close, method returns empty buffer
50 * @param[in] size Maximum number of bytes to read from input
51 * @return Buffer containing read bytes
54 virtual BinaryQueueAutoPtr Read(size_t size) = 0;
58 #endif // DPL_ABSTRACT_INPUT_H