SR::InputStream< StreamType > Class Template Reference

Template class to wrap data stream to a listener object. More...

#include <inputstream.h>

Public Member Functions
	~InputStream ()
	Cleans up the associated StreamType stream. More...
void	set (std::shared_ptr< StreamType > input)
	Must be set to allow proper cleanup of internal stream. More...

Detailed Description

template<typename StreamType>
class SR::InputStream< StreamType >

Template class to wrap data stream to a listener object.

Template Parameters

StreamType

should be a stream object with a stopListening() function such as a GenericStream implementation

This should be a member of any listener implementation!

Constructor & Destructor Documentation

~InputStream()

template<typename StreamType >

SR::InputStream< StreamType >::~InputStream ( )

inline

Cleans up the associated StreamType stream.

Member Function Documentation

set()

template<typename StreamType >

void SR::InputStream< StreamType >::set ( std::shared_ptr< StreamType >  input )

inline

Must be set to allow proper cleanup of internal stream.

Parameters

input

stream of StreamType to be cleaned up after destruction

All implementations of SR listeners should call this function as part of their constructor. Doing so ensures that the stream is stopped and cleaned up correctly. Alternatively, users can call stopListening on the stream themselves.

---

The documentation for this class was generated from the following file:

• inputstream.h