icinga2/lib/base/stream.hpp

151 lines
4.1 KiB
C++
Raw Normal View History

2012-07-16 00:04:16 +02:00
/******************************************************************************
* Icinga 2 *
2016-01-12 08:29:59 +01:00
* Copyright (C) 2012-2016 Icinga Development Team (https://www.icinga.org/) *
2012-07-16 00:04:16 +02:00
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program 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 General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software Foundation *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
2012-11-22 12:04:32 +01:00
#ifndef STREAM_H
#define STREAM_H
2012-07-16 00:02:31 +02:00
2014-05-25 16:23:35 +02:00
#include "base/i2-base.hpp"
#include "base/object.hpp"
#include <boost/signals2.hpp>
2013-03-15 18:21:29 +01:00
2012-07-16 00:02:31 +02:00
namespace icinga
{
class String;
class Stream;
enum ConnectionRole
{
RoleClient,
RoleServer
};
2015-07-15 11:24:34 +02:00
struct I2_BASE_API StreamReadContext
{
StreamReadContext(void)
: Buffer(NULL), Size(0), MustRead(true), Eof(false)
{ }
~StreamReadContext(void)
{
free(Buffer);
}
bool FillFromStream(const intrusive_ptr<Stream>& stream, bool may_wait);
void DropData(size_t count);
char *Buffer;
size_t Size;
bool MustRead;
bool Eof;
};
enum StreamReadStatus
{
StatusNewItem,
StatusNeedData,
StatusEof
};
2012-07-16 00:02:31 +02:00
/**
2012-11-22 12:04:32 +01:00
* A stream.
2012-09-17 13:35:55 +02:00
*
* @ingroup base
2012-07-16 00:02:31 +02:00
*/
2012-11-22 12:04:32 +01:00
class I2_BASE_API Stream : public Object
2012-07-16 00:02:31 +02:00
{
public:
2014-11-07 12:32:25 +01:00
DECLARE_PTR_TYPEDEFS(Stream);
2012-11-22 12:04:32 +01:00
2015-06-22 11:11:21 +02:00
/**
* Reads data from the stream without removing it from the stream buffer.
*
* @param buffer The buffer where data should be stored. May be NULL if you're
* not actually interested in the data.
* @param count The number of bytes to read from the queue.
* @param allow_partial Whether to allow partial reads.
* @returns The number of bytes actually read.
*/
virtual size_t Peek(void *buffer, size_t count, bool allow_partial = false);
2012-07-16 00:02:31 +02:00
/**
2012-11-22 12:04:32 +01:00
* Reads data from the stream.
2012-07-16 00:02:31 +02:00
*
* @param buffer The buffer where data should be stored. May be NULL if you're
* not actually interested in the data.
* @param count The number of bytes to read from the queue.
* @param allow_partial Whether to allow partial reads.
2012-11-22 12:04:32 +01:00
* @returns The number of bytes actually read.
2012-07-16 00:02:31 +02:00
*/
virtual size_t Read(void *buffer, size_t count, bool allow_partial = false) = 0;
2012-07-16 00:02:31 +02:00
/**
2012-11-22 12:04:32 +01:00
* Writes data to the stream.
2012-07-16 00:02:31 +02:00
*
* @param buffer The data that is to be written.
* @param count The number of bytes to write.
* @returns The number of bytes written
*/
virtual void Write(const void *buffer, size_t count) = 0;
2012-11-22 12:04:32 +01:00
2015-06-22 11:11:21 +02:00
/**
* Causes the stream to be closed (via Close()) once all pending data has been
* written.
*/
virtual void Shutdown(void);
2012-11-22 12:04:32 +01:00
/**
* Closes the stream and releases resources.
*/
virtual void Close(void);
2012-11-22 12:04:32 +01:00
/**
* Checks whether we've reached the end-of-file condition.
*
* @returns true if EOF.
*/
virtual bool IsEof(void) const = 0;
/**
* Waits until data can be read from the stream.
*/
2015-06-22 11:11:21 +02:00
bool WaitForData(int timeout = -1);
virtual bool SupportsWaiting(void) const;
virtual bool IsDataAvailable(void) const;
void RegisterDataHandler(const boost::function<void(const Stream::Ptr&)>& handler);
StreamReadStatus ReadLine(String *line, StreamReadContext& context, bool may_wait = false);
protected:
void SignalDataAvailable(void);
private:
boost::signals2::signal<void(const Stream::Ptr&)> OnDataAvailable;
boost::mutex m_Mutex;
boost::condition_variable m_CV;
2012-07-16 00:02:31 +02:00
};
}
2012-11-22 12:04:32 +01:00
#endif /* STREAM_H */