[Autosec-devel] sonar/plugins network_icmp.h,1.34,1.35

[red0x <re...@us...>]

Update of /cvsroot/autosec/sonar/plugins
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10223/plugins

Modified Files:
	network_icmp.h 
Log Message:
Major documentation update, more to come.

Index: network_icmp.h
===================================================================
RCS file: /cvsroot/autosec/sonar/plugins/network_icmp.h,v
retrieving revision 1.34
retrieving revision 1.35
diff -C2 -d -r1.34 -r1.35
*** network_icmp.h	13 Apr 2004 03:42:07 -0000	1.34
--- network_icmp.h	5 May 2004 08:01:29 -0000	1.35
***************
*** 76,101 ****
  
  
! /**
!   * @struct recv_t
!   * Argument passed to the recveiving thread
    */
  struct recv_t
  {
!     // / socket to listen on (must already be open)
      int socket;
!     // / number of hosts we pinged
      unsigned int hosts;
!     // / set the number of responses
      unsigned int responses;
!     // / start time
      unsigned int start;
!     // / max wait time (timeout function)
      unsigned int max;
  };
  
  typedef struct icmp_options_s
  {
      uint8_t ttl;
      uint8_t debug;
      uint32_t size;
  } icmp_options_t;
--- 76,109 ----
  
  
! /*! \struct recv_t
! 	\brief Argument passed to the recveiving thread in the icmp plugin
! 	
! 	This is for the threaded receiving functionality of the 
! 	icmp scan plugin.
    */
  struct recv_t
  {
!     //! socket to listen on (must already be open)
      int socket;
!     //! number of hosts we pinged
      unsigned int hosts;
!     //! set the number of responses
      unsigned int responses;
!     //! start time
      unsigned int start;
!     //! max wait time (timeout function)
      unsigned int max;
  };
  
+ /*! \struct icmp_options_s
+ 	\brief Options local to the ICMP scan plugin
+ */
  typedef struct icmp_options_s
  {
+ 	//! Time to live for outgoing packets
      uint8_t ttl;
+ 	//! debug mode (undocumented)
      uint8_t debug;
+ 	//! packet size
      uint32_t size;
  } icmp_options_t;