SH::SinkEndpoint Class Reference

#include <SHEndpoint.h>

Inheritance diagram for SH::SinkEndpoint:

[legend]Collaboration diagram for SH::SinkEndpoint:

[legend]List of all members.

Public Member Functions
	SinkEndpoint (Base *mySH)
virtual SH_RC	connect (Endpoint *ep)
virtual SH_RC	disconnect ()
const SourceEndpoint *	getConnectedSourceEndpoint () const
virtual SH_RC	push (DataPtr item)
SH_RC	pull_from_peer (DataPtr &item, SourceUnit su=UnitDefault, size_t amount=0)
virtual void	pushReport (ReportPtr report)
virtual void	push_report_to_peer (ReportPtr report)
virtual SH_RC	changePos (u_int64 pos)

---

Constructor & Destructor Documentation

SH::SinkEndpoint::SinkEndpoint (  Base *  mySH  )

---

Member Function Documentation

virtual SH_RC SH::SinkEndpoint::changePos (  u_int64  pos  )  [virtual]

Implements SH::Endpoint.

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

See also: Endpoint Reimplemented from SH::Endpoint.

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

See also: Endpoint Reimplemented from SH::Endpoint.

const SourceEndpoint* SH::SinkEndpoint::getConnectedSourceEndpoint (   )  const

SH_RC SH::SinkEndpoint::pull_from_peer (  DataPtr &  item, SourceUnit  su = UnitDefault, size_t  amount = 0 )

Instead of accessing the connected source directly, the owning stream handler should use this function to pull data from this sink endpoint's connected source endpoint.

virtual SH_RC SH::SinkEndpoint::push (  DataPtr  item  )  [virtual]

Called when an upstream stream handler hands a data item to this endpoint's stream handler. In case of success, returns SH_OK. Returns SH_NOT_CONNECTED if the endpoint is not connected. Returns SH_NOT_STREAMING if the stream handler is not streaming. Returns SH_ACTIVE if the stream handler is neither a passive nor a through stream handler, ie. if a call to push() is not supposed to happen. In all error cases the data item is released. Reimplemented in SH::DevNullSinkEndpoint, SH::DummyLayerSinkEndpoint, SH::DynMultiplierSinkEndpoint, SH::FileSinkEndpoint, SH::PacketMultiplierSinkEndpoint, SH::RTPDecoderSinkEndpoint, SH::RTPSinkEndpoint, SH::NopSinkSinkEndpoint, and SH::PushPullSinkEndpoint.

virtual void SH::SinkEndpoint::push_report_to_peer (  ReportPtr  report  )  [virtual]

See also: Endpoint Implements SH::Endpoint.

virtual void SH::SinkEndpoint::pushReport (  ReportPtr  report  )  [virtual]

See also: Endpoint Implements SH::Endpoint.

---

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

• SHEndpoint.h

---