@@ -39,25 +39,25 @@ #endif #ifdef OF_HAVE_OPTIONAL_PROTOCOLS @optional #endif /** - * This callback is called when a stream did get ready for reading. + * \brief This callback is called when a stream did get ready for reading. * * \param stream The stream which did become ready for reading */ - (void)streamDidBecomeReadyForReading: (OFStream*)stream; /** - * This callback is called when a stream did get ready for writing. + * \brief This callback is called when a stream did get ready for writing. * * \param stream The stream which did become ready for writing */ - (void)streamDidBecomeReadyForWriting: (OFStream*)stream; /** - * This callback is called when an exception occurred on the stream. + * \brief This callback is called when an exception occurred on the stream. * * \param stream The stream on which an exception occurred */ - (void)streamDidReceiveException: (OFStream*)stream; @end @@ -82,28 +82,32 @@ #ifdef OF_HAVE_PROPERTIES @property (retain) id delegate; #endif /** + * \brief Creates a new OFStreamObserver. + * * \return A new, autoreleased OFStreamObserver */ + observer; /** + * \brief Returns the delegate for the OFStreamObserver. + * * \return The delegate for the OFStreamObserver */ - (id )delegate; /** - * Sets the delegate for the OFStreamObserver. + * \brief Sets the delegate for the OFStreamObserver. * * \param delegate The delegate for the OFStreamObserver */ - (void)setDelegate: (id )delegate; /** - * Adds a stream to observe for reading. + * \brief Adds a stream to observe for reading. * * This is also used to observe a listening socket for incoming connections, * which then triggers a read event for the observed stream. * * It is recommended that the stream you add is set to non-blocking mode. @@ -114,11 +118,11 @@ * \param stream The stream to observe for reading */ - (void)addStreamToObserveForReading: (OFStream*)stream; /** - * Adds a stream to observe for writing. + * \brief Adds a stream to observe for writing. * * It is recommended that the stream you add is set to non-blocking mode. * * If there is an -[observe] call blocking, it will be canceled. The reason for * this is to prevent blocking even though the new added stream is ready. @@ -126,37 +130,37 @@ * \param stream The stream to observe for writing */ - (void)addStreamToObserveForWriting: (OFStream*)stream; /** - * Removes a stream to observe for reading. + * \brief Removes a stream to observe for reading. * * If there is an -[observe] call blocking, it will be canceled. The reason for * this is to prevent the removed stream from still being observed. * * \param stream The stream to remove from observing for reading */ - (void)removeStreamToObserveForReading: (OFStream*)stream; /** - * Removes a stream to observe for writing. + * \brief Removes a stream to observe for writing. * * If there is an -[observe] call blocking, it will be canceled. The reason for * this is to prevent the removed stream from still being observed. * * \param stream The stream to remove from observing for writing */ - (void)removeStreamToObserveForWriting: (OFStream*)stream; /** - * Observes all streams and blocks until an event happens on a stream. + * \brief Observes all streams and blocks until an event happens on a stream. */ - (void)observe; /** - * Observes all streams until an event happens on a stream or the timeout is - * reached. + * \brief Observes all streams until an event happens on a stream or the + * timeout is reached. * * \param timeout The time to wait for an event, in milliseconds * \return A boolean whether events occurred during the timeinterval */ - (BOOL)observeWithTimeout: (int)timeout;