@@ -28,12 +28,12 @@ @class OFMutableArray; @class OFMutableDictionary; @class OFDataArray; @class OFMutex; -/** - * \brief A protocol that needs to be implemented by delegates for +/*! + * @brief A protocol that needs to be implemented by delegates for * OFStreamObserver. */ #ifndef OF_STREAM_OBSERVER_M @protocol OFStreamObserverDelegate #else @@ -40,41 +40,41 @@ @protocol OFStreamObserverDelegate #endif #ifdef OF_HAVE_OPTIONAL_PROTOCOLS @optional #endif -/** - * \brief 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. * * NOTE: When -[tryReadLine] or -[tryReadTillDelimiter:] has been called on the * the stream, this callback will not be called again until new data has * been received, even though there is still data in the cache. The reason * for this is to prevent spinning in a loop when there is an incomplete * string in the cache. Once the string is complete, the callback will be * called again if there is data in the cache. * - * \param stream The stream which did become ready for reading + * @param stream The stream which did become ready for reading */ - (void)streamIsReadyForReading: (OFStream*)stream; -/** - * \brief 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 + * @param stream The stream which did become ready for writing */ - (void)streamIsReadyForWriting: (OFStream*)stream; -/** - * \brief 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 + * @param stream The stream on which an exception occurred */ - (void)streamDidReceiveException: (OFStream*)stream; @end -/** - * \brief A class that can observe multiple streams at once. +/*! + * @brief A class that can observe multiple streams at once. * * Note: Currently, Win32 can only observe sockets and not files! */ @interface OFStreamObserver: OFObject { @@ -94,94 +94,94 @@ #ifdef OF_HAVE_PROPERTIES @property (assign) id delegate; #endif -/** - * \brief Creates a new OFStreamObserver. +/*! + * @brief Creates a new OFStreamObserver. * - * \return A new, autoreleased OFStreamObserver + * @return A new, autoreleased OFStreamObserver */ + (instancetype)observer; -/** - * \brief Returns the delegate for the OFStreamObserver. +/*! + * @brief Returns the delegate for the OFStreamObserver. * - * \return The delegate for the OFStreamObserver + * @return The delegate for the OFStreamObserver */ - (id )delegate; -/** - * \brief Sets the delegate for the OFStreamObserver. +/*! + * @brief Sets the delegate for the OFStreamObserver. * - * \param delegate The delegate for the OFStreamObserver + * @param delegate The delegate for the OFStreamObserver */ - (void)setDelegate: (id )delegate; -/** - * \brief 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. * * 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. * - * \param stream The stream to observe for reading + * @param stream The stream to observe for reading */ - (void)addStreamForReading: (OFStream*)stream; -/** - * \brief 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. * - * \param stream The stream to observe for writing - */ -- (void)addStreamForWriting: (OFStream*)stream; - -/** - * \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)removeStreamForReading: (OFStream*)stream; - -/** - * \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)removeStreamForWriting: (OFStream*)stream; - -/** - * \brief Observes all streams and blocks until an event happens on a stream. - */ -- (void)observe; - -/** - * \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 seconds - * \return A boolean whether events occurred during the timeinterval - */ -- (BOOL)observeWithTimeout: (double)timeout; - -/** - * \brief Cancels the currently blocking observe call. + * @param stream The stream to observe for writing + */ +- (void)addStreamForWriting: (OFStream*)stream; + +/*! + * @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)removeStreamForReading: (OFStream*)stream; + +/*! + * @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)removeStreamForWriting: (OFStream*)stream; + +/*! + * @brief Observes all streams and blocks until an event happens on a stream. + */ +- (void)observe; + +/*! + * @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 seconds + * @return A boolean whether events occurred during the timeinterval + */ +- (BOOL)observeWithTimeout: (double)timeout; + +/*! + * @brief Cancels the currently blocking observe call. * * This is automatically done when a new stream is added or removed by another * thread, but in some circumstances, it might be desirable for a thread to * manually stop the observe running in another thread. */