MaxOS::common::GenericOutputStream< Type > Class Template Reference

A stream that can be written to. More...

#include <outputStream.h>

Inheritance diagram for MaxOS::common::GenericOutputStream< Type >:

Public Member Functions
	GenericOutputStream ()
	__________________________________________Templates__________________________________________________///
	~GenericOutputStream ()
	Destructor of the GenericOutputStream class.
void	on_stream_read (Type) override
	Writes the date that was read from the input stream to the output stream.
void	on_end_of_stream (GenericInputStream< Type > *) override
	Close the stream and remove it from the list of streams when the end of the stream is reached.
virtual void	write (Type)
	write an element to the stream.
virtual void	close ()
	Close the stream.
virtual GenericOutputStream< Type > &	operator<< (Type)
	Overload the << operator to write an element to the stream.
Public Member Functions inherited from MaxOS::common::InputStreamProcessor< Type, Type >
	InputStreamProcessor ()
	Creates a new InputStreamProcessor.
	InputStreamProcessor (InputStreamEventHandler< Type > *generic_stream_event_handler)
	Creates a new InputStreamProcessor.
	~InputStreamProcessor ()
	Destroys the InputStreamProcessor.
void	on_end_of_stream (GenericInputStream< Type > *stream) override
	Called when a stream has finished. Passes the event on to the handlers and then removes the stream from the array of streams.
Public Member Functions inherited from MaxOS::common::InputStreamEventHandler< Type >
	InputStreamEventHandler ()
	_______________________________________________TEMPLATES_________________________________________________________________///
	~InputStreamEventHandler ()
	Destroys the InputStreamProcessor and disconnects it from all streams.
Public Member Functions inherited from MaxOS::common::GenericInputStream< Type >
	GenericInputStream ()
	Creates a new GenericInputStream.
	GenericInputStream (InputStreamEventHandler< Type > *)
	Creates a new GenericInputStream and connects it to the handler.
	~GenericInputStream ()
	Destroys the GenericInputStream and disconnects all handlers.
void	connect_input_stream_event_handler (InputStreamEventHandler< Type > *)
	Adds a inputStreamEventHandler to the list of internetProtocolHandlers.
void	disconnect_input_stream_event_handler (InputStreamEventHandler< Type > *)
	Removes a handler from the list of handlers.

Additional Inherited Members
Protected Attributes inherited from MaxOS::common::InputStreamEventHandler< Type >
common::Vector< GenericInputStream< Type > * >	m_generic_input_streams
	List of streams being observed by this handler.
Protected Attributes inherited from MaxOS::common::GenericInputStream< Type >
common::Vector< InputStreamEventHandler< Type > * >	m_input_stream_event_handlers
	List of streams being observed by this handler.

Detailed Description

template<class Type>
class MaxOS::common::GenericOutputStream< Type >

A stream that can be written to.

Template Parameters

Type	The type of the elements that will be written to the stream.

Definition at line 25 of file outputStream.h.

Constructor & Destructor Documentation

GenericOutputStream()

template<class Type >

MaxOS::common::GenericOutputStream< Type >::GenericOutputStream ( )

default

__________________________________________Templates__________________________________________________///

Constructor of the GenericOutputStream class.

Template Parameters

Type	The type of the elements that will be written to the stream.

~GenericOutputStream()

template<class Type >

MaxOS::common::GenericOutputStream< Type >::~GenericOutputStream ( )

default

Destructor of the GenericOutputStream class.

Template Parameters

Type	The type of the elements that will be written to the stream.

Member Function Documentation

close()

template<class Type >

void MaxOS::common::GenericOutputStream< Type >::close ( )

virtual

Close the stream.

Template Parameters

Type	The type of the elements that will be written to the stream.

Definition at line 136 of file outputStream.h.

                                                               {
 
    }

on_end_of_stream()

template<class Type >

void MaxOS::common::GenericOutputStream< Type >::on_end_of_stream ( GenericInputStream< Type > *  stream )

overridevirtual

Close the stream and remove it from the list of streams when the end of the stream is reached.

Template Parameters

Type	The type of the elements that will be written to the stream.

Parameters

stream

The stream that reached the end.

Reimplemented from MaxOS::common::InputStreamEventHandler< Type >.

Definition at line 108 of file outputStream.h.

                                                                                                          {
 
        // Close the stream.
        close();
 
        // Pass the event to any handlers
        for(auto& input_stream_event_handler : this->m_input_stream_event_handlers)
            input_stream_event_handler->on_end_of_stream(stream);
 
        // Remove the stream from the list of streams.
        InputStreamProcessor<Type, Type>::on_end_of_stream(stream);
 
    }

References MaxOS::common::InputStreamProcessor< Type, ProcessorType >::on_end_of_stream().

on_stream_read()

template<class Type >

void MaxOS::common::GenericOutputStream< Type >::on_stream_read ( Type  read_element )

overridevirtual

Writes the date that was read from the input stream to the output stream.

Template Parameters

Type	The type of the elements that will be written to the stream.

Parameters

read_element

The element that was read from the stream.

Reimplemented from MaxOS::common::InputStreamEventHandler< Type >.

Definition at line 90 of file outputStream.h.

                                                                                         {
 
        // When something is read from the input stream, it is written to the output stream.
        write(read_element);
 
        // Pass the element to any handlers
        for(auto& input_stream_event_handler : this->m_input_stream_event_handlers)
            input_stream_event_handler->on_stream_read(read_element);
 
 
    }

operator<<()

template<class Type >

GenericOutputStream< Type > & MaxOS::common::GenericOutputStream< Type >::operator<< ( Type  write_element )

virtual

Overload the << operator to write an element to the stream.

Template Parameters

Type	The type of the elements that will be written to the stream.

Parameters

write_element

The element that will be written to the stream.

Returns

The stream

Definition at line 136 of file outputStream.h.

                                                                                                             {
 
        // write the element to the stream.
        write(write_element);
 
        // Return the stream.
        return *this;
    }

write()

template<class Type >

void MaxOS::common::GenericOutputStream< Type >::write ( Type  )

virtual

write an element to the stream.

Template Parameters

Type	The type of the elements that will be written to the stream.

Definition at line 127 of file outputStream.h.

                                                                   {
 
    }

---

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

• /home/runner/work/MaxOS/MaxOS/kernel/include/common/outputStream.h