1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-ws-lib
* Created on: 16 авг. 2019 г.
*
* lsp-ws-lib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-ws-lib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-ws-lib. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_WS_IDATASINK_H_
#define LSP_PLUG_IN_WS_IDATASINK_H_
#include <lsp-plug.in/ws/version.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/common/status.h>
namespace lsp
{
namespace ws
{
/**
* Data sink interface for asynchronous receive of binary data
*/
class LSP_WS_LIB_PUBLIC IDataSink
{
private:
IDataSink & operator = (const IDataSink &);
IDataSink(const IDataSink &);
protected:
ssize_t nReferences;
public:
/**
* Create data sink with specified MIME type
* @param mime MIME type of the data sink
*/
explicit IDataSink();
/**
* Destroy data sink
*/
virtual ~IDataSink();
public:
/**
* Open sink for writing
* @param mime_types NULL-terminated list of available MIME type of the data
* @return index of selected MIME type or negative error code
*/
virtual ssize_t open(const char * const *mime_types);
/**
* Write amount of bytes to the sink
* @param buf buffer to write
* @param count number of bytes to write
* @return status of operation
*/
virtual status_t write(const void *buf, size_t count);
/**
* Close sink
* @param code the data transfer completion code
*/
virtual status_t close(status_t code);
/**
* Acquire data sink for usage
* @return number of references
*/
size_t acquire();
/**
* Get number of references to the data sink
* @return number of references to the data sink
*/
inline size_t references() const { return nReferences; };
/**
* Release data source
* @return number of references to the data source
*/
size_t release();
};
} /* namespace ws */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_WS_IDATASINK_H_ */
|