Changeset 20993

Show
Ignore:
Timestamp:
01/12/08 06:40:56 (9 months ago)
Author:
patrick
Message:

Made improvements to Doxygen comments and silenced Doxygen warnings.
No functional changes.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/trunk/modules/vapor/vpr/IO/Socket/SocketDatagram_t.h

    r20974 r20993  
    128128    * Receives a message from some source.  The source's address is writen 
    129129    * into the by-reference parameter \p from. 
    130     * @throws vpr::IOException if the operation failed. 
     130    * 
     131    * @throw vpr::IOException Thrown if the operation failed. 
    131132    */ 
    132133   vpr::Uint32 recvfrom(void* msg, const vpr::Uint32 len, 
    …… 
    140141    * Receives a message from some source.  The source's address is writen 
    141142    * into the by-reference parameter \p from. 
    142     * @throws vpr::IOException if the operation failed. 
     143    * 
     144    * @throw vpr::IOException Thrown if the operation failed. 
    143145    */ 
    144146   vpr::Uint32 recvfrom(std::string& msg, const vpr::Uint32 len, 
    …… 
    155157    * Receives a message from some source.  The source's address is writen 
    156158    * into the by-reference parameter \p from. 
    157     * @throws vpr::IOException if the operation failed. 
     159    * 
     160    * @throw vpr::IOException Thrown if the operation failed. 
    158161    */ 
    159162   vpr::Uint32 recvfrom(std::vector<vpr::Uint8>& msg, 
    …… 
    175178   /** 
    176179    * Sends a message to the designated recipient. 
    177     * @throws vpr::IOException if the operation failed. 
     180    * 
     181    * @throw vpr::IOException Thrown if the operation failed. 
    178182    */ 
    179183   vpr::Uint32 sendto(const void* msg, const vpr::Uint32 len, 
    …… 
    186190   /** 
    187191    * Sends a message to the designated recipient. 
    188     * @throws vpr::IOException if the operation failed. 
     192    * 
     193    * @throw vpr::IOException Thrown if the operation failed. 
    189194    */ 
    190195   vpr::Uint32 sendto(const std::string& msg, const vpr::Uint32 len, 
    …… 
    198203   /** 
    199204    * Sends a message to the designated recipient. 
    200     * @throws vpr::IOException if the operation failed. 
     205    * 
     206    * @throw vpr::IOException Thrown if the operation failed. 
    201207    */ 
    202208   vpr::Uint32 sendto(const std::vector<vpr::Uint8>& msg, 
    …… 
    210216protected: 
    211217   /** 
    212     * @throws vpr::SocketException. 
     218    * @throw vpr::SocketException 
     219    *           Thrown if querying the indiccated option on this socket fails. 
    213220    */ 
    214221   virtual void getOption(const vpr::SocketOptions::Types option, 
    …… 
    220227 
    221228   /** 
    222     * @throws vpr::SocketException. 
     229    * @throw vpr::SocketException 
     230    *           Thrown if setting the indicated option on this socket fails. 
    223231    */ 
    224232   virtual void setOption(const vpr::SocketOptions::Types option, 

  • juggler/trunk/modules/vapor/vpr/IO/Socket/SocketStream_t.h

    r20974 r20993  
    132132    * @param backlog The maximum length of th queue of pending connections. 
    133133    * 
    134     * @throws vpr::SocketException if the socket could not be put into 
    135     *         a listening state. 
     134    * @throw vpr::SocketException 
     135    *           Thrown if the socket could not be put into a listening state. 
    136136    */ 
    137137   void listen(const int backlog = 5) 
    …… 
    153153    *                return. 
    154154    * 
    155     * @throws vpr::WouldBlockException if this is a non-blocking socket, 
    156     *         and there are no waiting connection requests. 
    157     * @throws vpr::TimeoutException if no connection requests arrived within 
    158     *         the given timeout period. 
    159     * @throws vpr::SocketException if the connection was not accepted because 
    160     *         of an error. 
     155    * @throw vpr::WouldBlockException 
     156    *           Thrown if this is a non-blocking socket, and there are no 
     157    *           waiting connection requests. 
     158    * @throw vpr::TimeoutException 
     159    *           Thrown if no connection requests arrived within the given 
     160    *           timeout period. 
     161    * @throw vpr::SocketException 
     162    *           Thrown if the connection was not accepted because of an error. 
    161163    * 
    162164    * @see open, bind, listen 
    …… 
    182184    * @param backlog   The maximum length of the pending connection queue. 
    183185    * 
    184     * @throws vpr::WouldBlockException if this is a non-blocking socket, 
    185     *         and there are no waiting connection requests. 
    186     * @throws vpr::TimeoutException if no connection requests arrived within 
    187     *         the given timeout period. 
    188     * @throws vpr::SocketException if the connection was not accepted because 
    189     *         of an error. 
     186    * @throw vpr::WouldBlockException 
     187    *           Thrown if this is a non-blocking socket, and there are no 
     188    *           waiting connection requests. 
     189    * @throw vpr::TimeoutException 
     190    *           Thrown if no connection requests arrived within the given 
     191    *           timeout period. 
     192    * @throw vpr::SocketException 
     193    *           Thrown if the connection was not accepted because of an error. 
    190194    */ 
    191195   void openServer(const bool reuseAddr = true, 
    …… 
    221225 
    222226   /** 
    223     * @THROWS vpr::SocketException. 
     227    * @throw vpr::SocketException 
     228    *           Thrown if querying the indiccated option on this socket fails. 
    224229    */ 
    225230   virtual void getOption(const vpr::SocketOptions::Types option, 
    …… 
    231236 
    232237   /** 
    233     * @THROWS vpr::SocketException. 
     238    * @throw vpr::SocketException 
     239    *           Thrown if setting the indicated option on this socket fails. 
    234240    */ 
    235241   virtual void setOption(const vpr::SocketOptions::Types option, 
    …… 
    238244      mSocketStreamImpl->setOption(option, data); 
    239245   } 
     246 
     247   /** @name TCP Corking Interface Implementation */ 
     248   //@{ 
     249   void setCorkAllocStrategy(const NoPushStrategy& s) 
     250   { 
     251      mSocketStreamImpl->setCorkAllocStrategy(s); 
     252   } 
     253 
     254   /** 
     255    * Calls through to the cork() method of the internal stream socket 
     256    * implementation. 
     257    * 
     258    * @since 2.1.9 
     259    * 
     260    * @see vpr::SocketStreamImplBSD::cork() 
     261    * @see vpr::SocketStreamImplNSPR::cork() 
     262    */ 
     263   virtual void cork() 
     264   { 
     265      mSocketStreamImpl->cork(); 
     266   } 
     267 
     268   /** 
     269    * Calls through to the uncork() method of the internal stream socket 
     270    * implementation. 
     271    * 
     272    * @since 2.1.9 
     273    * 
     274    * @see vpr::SocketStreamImplBSD::uncork() 
     275    * @see vpr::SocketStreamImplNSPR::uncork() 
     276    */ 
     277   virtual void uncork() 
     278   { 
     279      mSocketStreamImpl->uncork(); 
     280   } 
     281   //@} 
    240282 
    241283// Put in back door for simulator