X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FProtocols%2FDVB%2FDVBDemuxSocketProtocol.hh;h=632b5284ff543dbb483156c984c6bce47cd88ce2;hb=532240d72e09e19e57fac9bb55c2560b9c9e5b97;hp=e5963e911853ce23e5ae85aeab63d91ae329392a;hpb=25fe79f266e7583750d8e761abec4022d87972b8;p=senf.git diff --git a/Socket/Protocols/DVB/DVBDemuxSocketProtocol.hh b/Socket/Protocols/DVB/DVBDemuxSocketProtocol.hh index e5963e9..632b528 100644 --- a/Socket/Protocols/DVB/DVBDemuxSocketProtocol.hh +++ b/Socket/Protocols/DVB/DVBDemuxSocketProtocol.hh @@ -23,8 +23,8 @@ /** \file \brief DVBDemuxSocketProtocol public header */ -#ifndef HH_DVBDemuxSocketProtocol_ -#define HH_DVBDemuxSocketProtocol_ 1 +#ifndef HH_SENF_Socket_Protocols_DVB_DVBDemuxSocketProtocol_ +#define HH_SENF_Socket_Protocols_DVB_DVBDemuxSocketProtocol_ 1 #include @@ -39,14 +39,18 @@ namespace senf { /// \addtogroup protocol_facets_group /// @{ - /** xxx + /** \todo Document me! */ class DVBDemuxSocketProtocol : public virtual SocketProtocol { public: - void setBufferSize(unsigned long size) const; - + void setBufferSize(unsigned long size) const; + ///< set the size of the circular buffer used for filtered data. + /**< The default size is two maximum sized sections, i.e. if this + function is not called a buffer size of 2 * 4096 bytes will + be used. + \param[in] size Size of circular buffer. */ void startFiltering() const; void stopFiltering() const;