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

Manages the connection of a stream to handlers. More...

#include <inputStream.h>

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

Public Member Functions
	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.

Protected Attributes
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::GenericInputStream< Type >

Manages the connection of a stream to handlers.

Template Parameters

Type	The type of data the stream is handling

Definition at line 102 of file inputStream.h.

Constructor & Destructor Documentation

GenericInputStream() [1/2]

template<class Type >

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

default

Creates a new GenericInputStream.

Template Parameters

Type	The type of data the stream is handling

GenericInputStream() [2/2]

template<class Type >

MaxOS::common::GenericInputStream< Type >::GenericInputStream ( InputStreamEventHandler< Type > *  input_stream_event_handler )

explicit

Creates a new GenericInputStream and connects it to the handler.

Template Parameters

Type	The type of data the stream is handling

Parameters

input_stream_event_handler

The handler to handle the data

Definition at line 376 of file inputStream.h.

                                                                                                                               {
 
        // Connect the handler
        connect_input_stream_event_handler(input_stream_event_handler);
    }

~GenericInputStream()

template<class Type >

MaxOS::common::GenericInputStream< Type >::~GenericInputStream

(

)

Destroys the GenericInputStream and disconnects all handlers.

Template Parameters

Type	The type of data the stream is handling

Definition at line 387 of file inputStream.h.

                                                                       {
 
        // Disconnect all handlers
        while(!m_input_stream_event_handlers.empty())
            disconnect_input_stream_event_handler(*(m_input_stream_event_handlers.begin()));
    }

Member Function Documentation

connect_input_stream_event_handler()

template<class Type >

void MaxOS::common::GenericInputStream< Type >::connect_input_stream_event_handler

(

InputStreamEventHandler< Type > *

input_stream_event_handler

)

Adds a inputStreamEventHandler to the list of internetProtocolHandlers.

Template Parameters

Type	The type of data the stream is handling

Parameters

input_stream_event_handler

The inputStreamEventHandler to add

Definition at line 399 of file inputStream.h.

                                                                                                                                                    {
 
        // Don't add the handler if it is already connected
        if(m_input_stream_event_handlers.find(input_stream_event_handler) != m_input_stream_event_handlers.end())
            return;
 
        // Add the handler
        m_input_stream_event_handlers.push_back(input_stream_event_handler);
 
    }

disconnect_input_stream_event_handler()

template<class Type >

void MaxOS::common::GenericInputStream< Type >::disconnect_input_stream_event_handler

(

InputStreamEventHandler< Type > *

input_stream_event_handler

)

Removes a handler from the list of handlers.

Template Parameters

Type	The type of data the stream is handling

Parameters

input_stream_event_handler

The handler to remove

Definition at line 416 of file inputStream.h.

                                                                                                                                                       {
 
        // Don't remove the handler if it is not connected
        if(m_input_stream_event_handlers.find(input_stream_event_handler) == m_input_stream_event_handlers.end())
            return;
 
        // Remove the handler
        m_input_stream_event_handlers.erase(input_stream_event_handler);
 
        // Fire the end of stream event
        input_stream_event_handler->on_end_of_stream(this);
 
    }

References MaxOS::common::InputStreamEventHandler< Type >::on_end_of_stream().

Member Data Documentation

m_input_stream_event_handlers

template<class Type >

common::Vector<InputStreamEventHandler<Type>*> MaxOS::common::GenericInputStream< Type >::m_input_stream_event_handlers

protected

List of streams being observed by this handler.

Definition at line 105 of file inputStream.h.

---

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

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