Skip to content
Snippets Groups Projects
Commit 0df47ce1 authored by tho's avatar tho
Browse files

added documentation note for SocketProtocol::available()

parent da5ed6f9
No related branches found
No related tags found
No related merge requests found
// $Id: DVBSectionHandle.cc 321 2007-07-19 09:00:23Z tho $
// $Id$
//
// Copyright (C) 2007
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
......
// $Id: DVBDemuxSectionHandle.hh 321 2007-07-19 09:00:23Z tho $
// $Id$
//
// Copyright (C) 2007
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
......@@ -49,8 +49,7 @@ namespace senf {
DatagramFramingPolicy,
UnconnectedCommunicationPolicy,
ReadablePolicy,
NotWriteablePolicy,
SocketBufferingPolicy
NotWriteablePolicy
>::policy DVBDemux_Policy; ///< Socket Policy for xxxx
/** \brief xxx
......
// $Id: DVBProtocol.cc 321 2007-07-19 09:00:23Z tho $
// $Id$
//
// Copyright (C) 2007
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
......
// $Id: DVBProtocol.hh 321 2007-07-19 09:00:23Z tho $
// $Id$
//
// Copyright (C) 2007
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
......
......@@ -363,7 +363,7 @@ namespace senf {
</table>
The second member should only be enabled if the communication policy is
UnconnectedCommunication (otherwise it does not make sense since the communication partner
UnconnectedCommunicationPolicy (otherwise it does not make sense since the communication partner
is fixed) (see AddressingPolicyBase on how to do this).
\note This Policy only has two meaningful states: ReadablePolicy and NotReadablePolicy. It
......@@ -386,7 +386,7 @@ namespace senf {
</table>
The second member should only be enabled if the communication policy is
UnconnectedCommunication (otherwise it does not make sense since the communication partner
UnconnectedCommunicationPolicy (otherwise it does not make sense since the communication partner
is fixed) (see AddressingPolicyBase on how to do this).
\note This Policy only has two meaningful states: WritablePolicy and NotWritablePolicy. It
......
......@@ -155,7 +155,9 @@ namespace senf {
/**< This member will check in a (very, sigh) protocol
dependent way, how many bytes are guaranteed to be
readable from the socket without blocking even if the
socket is blocking. */
socket is blocking. If the socket does not support
reading (viz. NotReadablePolicy is set), this member
should always return \c 0.*/
virtual bool eof() const = 0; ///< Check for end-of-file condition
/**< This is another check which (like available()) is
......
......@@ -54,7 +54,7 @@ body {
}
#head ul {
display: inline; /* fr IE ... */
display: inline; /* fr IE ... */
font-size: 13px;
height: 0px;
margin: 0;
......@@ -191,7 +191,7 @@ div.tabs ul li a:hover, div.tabs ul li.current a {
}
div.tabs ul li.level1 a {
padding-left: 2em;
padding-left: 1.5em;
font-size: 90%;
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment