SH::Endpoint Class Reference

#include <SHEndpoint.h>

Inheritance diagram for SH::Endpoint:

[legend]Collaboration diagram for SH::Endpoint:

[legend]List of all members.

Public Member Functions
	Endpoint (Base *mySH, bool isSink)
virtual	~Endpoint ()
void	init ()
void	uninit ()
virtual void	pushReport (ReportPtr report)=0
virtual SH_RC	connect (Endpoint *ep)
virtual SH_RC	disconnect ()
bool	is_connected () const
bool	is_sink () const
Base *	sh ()
	Retrieve the owning stream handler (for child classes only).
virtual SH_RC	changePos (u_int64 pos)=0
Protected Member Functions
virtual void	push_report_to_peer (ReportPtr report)=0

---

Detailed Description

An instanciated endpoint of a stream handler.

---

Constructor & Destructor Documentation

SH::Endpoint::Endpoint (  Base *  mySH, bool  isSink )

Endpoint(const DataPort& port) The primary constructor is meant to instantiate end points of a stream handler from their specification. The specification is stored in DataPort structures, the instantiation is requested by the graph manager.

virtual SH::Endpoint::~Endpoint (   )  [virtual]

---

Member Function Documentation

virtual SH_RC SH::Endpoint::changePos (  u_int64  pos  )  [pure virtual]

Implemented in SH::SinkEndpoint, and SH::SourceEndpoint.

virtual SH_RC SH::Endpoint::connect (  Endpoint *  ep  )  [virtual]

This function is mainly intended to remember that this endpoint is now connected, and the other endpoint's pointer. An error is return if a connection has already been made to this endpoint. Child classes may add additional checks. Reimplemented in SH::SinkEndpoint, and SH::SourceEndpoint.

virtual SH_RC SH::Endpoint::disconnect (   )  [virtual]

Remove a connection that has been made. Reimplemented in SH::SinkEndpoint, and SH::SourceEndpoint.

void SH::Endpoint::init (   )

bool SH::Endpoint::is_connected (   )  const

Indicates whether this endpoints if connected to exactly one other endpoint.

bool SH::Endpoint::is_sink (   )  const

Indicates whether this endpoint is a source or a sink.

virtual void SH::Endpoint::push_report_to_peer (  ReportPtr  report  )  [protected, pure virtual]

If this endpoints is connected, the Base can send the given report to the connected endpoint by calling this function on its own endpoint. Implemented in SH::SinkEndpoint, and SH::SourceEndpoint.

virtual void SH::Endpoint::pushReport (  ReportPtr  report  )  [pure virtual]

This endpoint receives a report from its connected endpoint. The direction (upstream,downstream) of the report is implicit. The interpretation of the report is specific to the stream handler. If an endpoint in the opposite direction exists, a stream handler must forward reports to all endpoints at the opposite side if it is unable to interpret that report. Implemented in SH::SinkEndpoint, and SH::SourceEndpoint.

Base* SH::Endpoint::sh (   )

Retrieve the owning stream handler (for child classes only).

void SH::Endpoint::uninit (   )

---

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

• SHEndpoint.h

---