SH::Base::SHSide Class Reference

#include <SH.h>

Collaboration diagram for SH::Base::SHSide:

[legend]List of all members.

Protected Member Functions
	SHSide ()
	~SHSide ()
SH_RC	validateUnconnected (Endpoint *dp)
SH_RC	connected (Endpoint *dp)

---

Detailed Description

Inner class for endpoint management.
The SHSide inner class is a concrete class intended for the management of endpoints within a stream handler. It holds lists and counters for instantiated and connected endpoints. It provides functions to send a data item to all connected endpoints. If no endpoint is connected during such a call, the data item is released.
The SHSide class does neither know nor care about the status of the stream handler, ie. it will perform operations whether the stream handler is streaming or not.

---

Constructor & Destructor Documentation

SH::Base::SHSide::SHSide (   )  [protected]

Constructor.

SH::Base::SHSide::~SHSide (   )  [protected]

Destructor.

---

Member Function Documentation

SH_RC SH::Base::SHSide::connected (  Endpoint *  dp  )  [protected]

Informs the SHSide object of an endpoint's successful connection. Move an endpoint from the _unconnected to the _table. This function is called by the SH after establishing the connection. Parameters: dp  The endpoint to be moved into the table of connected endpoints. Returns: SH_OK in case of success. SH_ALREADY_CONNECTED if it is already in the table of connected endpoints. SH_MISSING if the endpoint is neither in the connected nor in the unconnected table.

SH_RC SH::Base::SHSide::validateUnconnected (  Endpoint *  dp  )  [protected]

Verifies that the given endpoint is registered but unconnected. If a graph manager decides to connect two endpoints, it passes the endpoint to a stream handler. In order to prevent errors, the stream handler verifies before a connect operation that the given endpoint belonging to itself is not connected yet. Whether the stream handler checks with its source side or with its sink side is implicitly clear from the connect function. Parameters: dp  The endpoint to be checked. Returns: SH_OK if the endpoint is not connected. SH_ALREADY_CONNECTED if the endpoint is already connected.

---

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

• SH.h

---